java代码规范文档
原则:
注释形式统一
在整个应用程序中,使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同,按照这份规范写代码,不要试图在既成的规范系统中引入新的规范。
注释内容准确简洁
内容要简单、明了、含义准确,防止注释的多义性,错误的注释不但无益反而有害。
注释条件
基本注释
1.类(接口)的注释
2.构造函数的注释
3.方法的注释
4.全局变量的注释
5.字段/属性的注释
特殊必加注释
1.典型算法必须有注释
2.在代码不明晰处必须有注释
3.在代码修改处加上修改标识注释
4.在循环和逻辑分支组成的代码中加注释
5.为他人提供的接口必须加详细注释
注释格式
单行(single-line)注释:“//……”
块(block)注释:“/……/”
文档注释:“/*……/”
javadoc 注释标签语法
@author 对类的说明 标明开发该类模块的作者
@version 对类的说明 标明该类模块的版本
@see 对类、属性、方法的说明 参考转向,也就是相关主题
@param 对方法的说明 对方法中某参数的说明
@return 对方法的说明 对方法返回值的说明
@exception 对方法的说明 对方法可能抛出的异常进行说明
参考实例
类(接口)的注释
/**
* @Description 类的描述
* @author Administrator
* @Time 2018-09-28
* @version v1.1
*/
public class testEwallet {
}
构造函数的注释
/**
* @Description 构造方法描述
* @param name
* 按钮上显示文字
*/
public testEwallet(String name){
}
方法注释
/**
* 为按钮添加颜色
* @param color
* 按钮的颜色
* @return
* @exception (方法有异常的话加)
* @author Administrator
* @Time2012-11-20 15:02:29
*/
public voidaddColor(String color){
}
全局变量注释
/** The value is used for characterstorage. */
private final char value[];
字段/属性注释
private String senderName;//发送人姓名
private String title;//不能超过120个中文字符