码迷,mamicode.com
首页 > 编程语言 > 详细

java开发规范

时间:2018-12-21 16:08:59      阅读:250      评论:0      收藏:0      [点我收藏+]

标签:des   eclips   修改内容   mail   数据   设计   ram   内容   1.2   

软件开发规范



一. 命名规范 


1.1 项目命名规范 

包命名规范

例:cn.cnnho.工程名.具体包名

 

类、接口命名规范

1.首字母大写,遵循驼峰命名法则。

2.尽量使用英文,要么使用拼音。不要英文和拼音结合使用

例:UserBean



1.2 jsp/Html命名规范 
jsp与html文件名全部小写,并遵循如下的规范: 

数据/内容显示页 
名词,多个单词用下划线分隔,要求能说明显示内容的信息,为避免冲突,可加上 “_list”。

例: new_message.html 或 my_file_list.jsp 

操作处理页

命名格式:名词_下划线_动词

例:file_delete.jsp。 

javascript脚本方法 
脚本函数都以

①xxx_②xxx的方式命名。 
①xxx对应页面隶属的模块。 
②xxx表示函数所要实现的功能(动宾结构),多个单词用下划线连接。 
例:ebwebmail_send_mail() 

模块通用的脚本函数必须集合于一个js文件中,在页面上通过<script language=”Javascript” src=”url”></script>形式导入。js文件名命名使用模块名,例如:ebwebmail.js。 

假如项目已经提供了公共js脚本,则优先使用公共js脚本中提供的函数。 

所有定义方法的<script>元素定义在<head></head>中或</body>后。 

javascript脚本内部变量与参数 
单词之间用下划线分隔且全部小写

例: var file_size。 

 

二.注释规范

 

     类/接口注释

     类,接口描述,一般作详细描述。按照常用的说明顺序呢排列,主要包括

          1.类的描述,以。或.结束。

          2.类设计的目标,完成什么样的功能一般和类的描述合并在一起。

          3.<Strong>主要的类使用</Strong>如何使用该类,包括环境要求,比如线程是否安全,并发性要求以及使用约束。

          4.<Strong>已知的BUG</Strong>

          5.描述类的修改历史:<Strong>修改人+日期+简单说明</Strong>

          6.@author作者、@version版本,@see参照,@since开始版本信息

     例:

  /**  

* @Title: ${file_name} 

* @Package ${package_name} 

* @Description: ${todo}

* @author:zhangsan

* @date ${date} ${time} 

* @version V1.0  

*/

 

     方法注释

     方法描述说明,主要对方法的描述,参数、返回值、抛出异常进行说明。

     例:

 /**

* @Title: ${enclosing_method}

* @Description: ${todo}

* @param ${tags}

* @return ${return_type}

* @throws

*/

 

     修改注释

     在修改处一定要添加注释,说明修改人,修改原因,修改内容,修改时间

 

以myEclipse为例添加自动注释

Window→Preferences→java→Code Style→Code Templates→Comments→Types

Files:

/**  

* @Title: ${file_name} 

* @Package ${package_name} 

* @Description: ${todo}

* @author:Jiaguangxiang

* @date ${date} ${time} 

* @version V1.0  

*/

Types:

/**

* @Description: ${todo}

* @version v1.0

* @author:Jiaguangxiang

* @date:${date} ${time}

*/

Methods:

/**

* @Title: ${enclosing_method}

* @Description: ${todo}

* @param ${tags}

* @return ${return_type}

* @throws

*/

 

java开发规范

标签:des   eclips   修改内容   mail   数据   设计   ram   内容   1.2   

原文地址:https://www.cnblogs.com/guangxiang/p/10155990.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!