JAVA的注释规范
2018-02-25 11:44
267 查看
1、类注释
在每个类前面必须加上类注释,注释模板如下:/**
* Copyright (C), 2006-2010, ChengDu Lovo info. Co., Ltd.
* FileName: Test.java
* 类的详细说明
*
* @author 类创建者姓名
* @Date 创建日期
* @version 1.00
*/2、属性注释
在每个属性前面必须加上属性注释,注释模板如下:/** 提示信息 */
private String strMsg = null;3、方法注释
在每个方法前面必须加上方法注释,注释模板如下:/**
* 类方法的详细使用说明
*
* @param 参数1 参数1的使用说明
* @return 返回结果的说明
* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/4、构造方法注释
在每个构造方法前面必须加上注释,注释模板如下:/**
* 构造方法的详细使用说明
*
* @param 参数1 参数1的使用说明
* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/5、方法内部注释
在方法内部使用单行或者多行注释,该注释根据实际情况添加。
如://背景颜色
Color bgColor = Color.RED
在每个类前面必须加上类注释,注释模板如下:/**
* Copyright (C), 2006-2010, ChengDu Lovo info. Co., Ltd.
* FileName: Test.java
* 类的详细说明
*
* @author 类创建者姓名
* @Date 创建日期
* @version 1.00
*/2、属性注释
在每个属性前面必须加上属性注释,注释模板如下:/** 提示信息 */
private String strMsg = null;3、方法注释
在每个方法前面必须加上方法注释,注释模板如下:/**
* 类方法的详细使用说明
*
* @param 参数1 参数1的使用说明
* @return 返回结果的说明
* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/4、构造方法注释
在每个构造方法前面必须加上注释,注释模板如下:/**
* 构造方法的详细使用说明
*
* @param 参数1 参数1的使用说明
* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/5、方法内部注释
在方法内部使用单行或者多行注释,该注释根据实际情况添加。
如://背景颜色
Color bgColor = Color.RED
相关文章推荐
- Java的注释规范整理
- Java开发代码规范之编程规约(六)——注释规约
- java代码注释规范
- java代码注释规范
- java注释规范
- [转]java代码注释规范
- java的注释规范
- 02--java中---注释、标识符、命名规范、数据类型
- java注释规范
- JAVA 代码注释规范
- 3.1java数据类型-注释-命名规范-简介
- java 规范(命名、注释 、Java 文件样式)
- Java标准注释及规范
- java注释规范
- Java和Android注释规范
- java编码规范_缩进和注释
- java基础2.Java命名规范与注释规范
- Java注释规范整理
- java注释规范
- 【日常记录】java的文章注释规范