By KevinLee 2016-4-20
仅供参考java
为了使软件开发过程顺畅,保证软件质量,因而有了这份开发规范文档。web
尽可能保证可以经过变量名得知变量的含义数据库
团队成员都应该造成良好的写注释的习惯,方便之后阅读,以及为了后期生成可读性良好的Java Doc数组
应该包含以下:
* 文件描述
* 做者
* 版本
* 建立日期时间
* 修改日期时间
* 参考信息jsp
提早设置好文件的模板Template
如如下模板:ide
/** * Description: * Author: KevinLee * Version: 1.0 * Create Date Time: ${DATE} ${TIME}. * Update Date Time: * @see */
通常在写完一个方法后使用快捷键生成一个块注释,IDE会自动帮咱们写入一些信息。
应该包含以下信息:
* 方法描述 Description:
* 参数信息 @param
* 返回信息 @return
* 异常信息 @Exception
* 参考信息(可选)@see also //指定一个类或者方法(经过类后面加#选择方法)
* 笔记信息(可选)Note:
如如下模板:svg
/** * Description: 返回一个“Hello”字符串 * @param str 一个字符串 * @return 返回一个字符串 * @throws Exception 抛出一个异常 * @see com.lidengju.entity.Person * Note: Nothing much. */
public String sayHello(String str) throws Exception{
str="Hello";
return str;
}
注意:方法里面不要使用块注释spa
应该包含以下信息:
* 一些程序关键的地方
* 一些程序不易读的地方
* 编写代码过程当中遇到问题的地方
* 须要提示读者的地方代码规范
注释应该写得少而易懂
若修改了文件,能够加上修改人的信息,和修改日期。code
应注意使用format来格式化代码,使用Tab键来缩进代码,至关于4个空格。
但愿各位成员遵照这份开发规范文档,养成良好的开发习惯