Java注释规范

一、注释规范

1、   类注释

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

 1         /**
 2 
 3         * Copyright (C), 2006-2010, ChengDu Lovo info. Co., Ltd.
 4 
 5         * FileName: Test.java
 6 
 7         * 类的详细说明
 8 
 9         *
10 
11         * @author 类创建者姓名
12             * @Date    创建日期
13 
14         * @version 1.00
15 
16         */

2、   属性注释

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

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

3、   方法注释

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

 1         /**
 2 
 3         * 类方法的详细使用说明
 4 
 5         *
 6 
 7         * @param 参数1 参数1的使用说明
 8 
 9         * @return 返回结果的说明
10 
11         * @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
12 
13         */

4、   构造方法注释

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

 1         /**
 2 
 3         * 构造方法的详细使用说明
 4 
 5         *
 6 
 7         * @param 参数1 参数1的使用说明
 8 
 9         * @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
10 
11         */

5、   方法内部注释

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

1         //背景颜色
2 
3         Color bgColor = Color.RED

内容仅供个人学习、记录使用，侵删

来源：https://www.cnblogs.com/japtx/p/11728079.html