Java中类注释规范

Java中类注释规范

1. 类注释

在每个类前面必须加上类注释，注释模板如下：

/**
 * 类的详细说明
 * 
 * @author ${USER}
     * @Date ${DATE}
 * @version 1.00
 */

在IntelliJ IDEA中实现：

2. 方法注释

在每个方法前面必须加上方法注释，注释模板如下：

/**
* 类方法的详细使用说明
*
* @param 参数1 参数1的使用说明
* @return 返回结果的说明
* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/

使用IntelliJ IDEA的Live Templates功能：

如上图所示，点击右侧的+，新建Live Template，然后编辑如上图，将应用范围设为Java，如果只设comment，无法智能提示，且必须/*再按tab才行。如果有一些 $var$,可以 编辑变量 在IntelliJ IDEA中，打出的部分就会智能提醒，Enter后恩Tab即可。

3. 属性注释

在每个属性前面必须加上属性注释，注释模板如下：

/** 提示信息 */
private String strMsg = null;

4. 构造方法注释

在每个构造方法前面必须加上注释，注释模板如下：

/**
* 构造方法的详细使用说明
*
* @param 参数1 参数1的使用说明
* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/

5. 方法内部注释

在方法内部使用单行或者多行注释，该注释根据实际情况添加。

如：

//背景颜色
Color bgColor = Color.RED