java的注释规范_Java代码注释规范

1，单行(单行)-简短说明: ///...

单行注释: 代码中的单行注释. 最好在注释前有一个空行，并在其后加上与代码相同的缩进级别. 如果无法完成一行，则应使用块注释.

评论格式:

在行首注释: 在代码行首注释. 主要是使代码行毫无意义.

评论格式: //评论内容

在行尾注释: 尾随-在代码行末尾非常简短的注释. 通常在代码行后8个(至少4个)空格，所有注释必须对齐.

评论格式: 代码+ 8个(至少4个)空格+ //评论内容

2. 阻止-阻止评论:

注释几行，通常用于提供文件，方法，数据结构等的含义和目的的描述，或算法的描述. 通常位于文件或方法的前面，它起着指导作用，也可以根据需要放置在合适的位置. 此域注释不会出现在HTML报告中. 注释格式通常写为:

3. 文件注释:

注释几行并写入javadoc文档. 每个文档注释都将放置在注释定界符中

其中，注释文档将用于生成HTML格式的代码报告，因此注释文本

The

文件必须在定义类，字段，构造函数，方法和字段之前编写. 注释文档由两部分组成: 描述和块标记. 批注文档的格式如下:

公共无效doGet(HttpServletRequest请求，HttpServletResponse响应)

引发ServletException，IOException {

doPost(请求，响应);

}

前两行的说明. 描述完成后，块符号以@符号开头. 更多文档说明

有关Shihe javadoc的详细信息，请参阅javadoc主页:

4. javadoc注释标记语法

@author对类的描述表示开发该模块的作者

有关该类的@version的说明表示该类的模块的版本

通过@see参考转向(即相关主题)来描述类，属性和方法

@param对方法的描述方法中的参数说明

@return方法说明该方法返回值的说明

@exception对方法的说明解释该方法可能引发的异常

六. JAVA注释的实现

1，源文件注释

注释源文件，并且在每个源文件的开头都需要必要的注释信息，包括: 文件名；文件编号;版本号；作者;创建时间；文件描述，包括此文件的历史记录修改记录. 中文注释模板:

2. 类(模块)注释:

使用类(模块)注释. 在每个类(模块)的开头，必须包括必要的注释信息，包括: 项目名称；类(模块)号；命名空间该类可以运行的JDK版本；版本号;作者;创建时间；类(模块)的功能描述(例如功能，主要算法，内部部件之间的关系，此类与其类之间的关系等)，必要时必须有一些特殊的软硬件要求等说明；此类(模块)的主要功能或过程列表以及历史修改记录.

英语注释模板:

如果模块仅修改少量代码，则每次修改都必须添加以释:

//重写器

//重写日期: 开始1:

// End1:

注释掉原始代码的内容，然后使用以释添加新代码:

//添加人

//添加日期: jsp代码注释，格式: YYYY-MM-DD>开始2:

// End2:

如果模块的输入和输出参数或功能结构有重大修改，则每次修改都必须添加以下内容

评论:

//日志ID:

//描述:

//作家: 修饰语的中文名称

//重写日期:

2. 界面说明:

使用接口注释. 基于令人满意的类批注，接口批注应包含有关接口用途，应如何使用以及不应如何使用的描述. 方框标记必须指明作者和版本. 在清除接口注释的前提下，可以不注释相应的实现类.

3. 构造说明:

构造函数注释使用，描述部分指示构造函数的作用，并且不一定有块标记.

注释模板1:

评论模板二:

4. 功能说明:

使用功能注释. 在每个功能或过程之前，必须有必要的注释信息，包括: 功能或过程名称；功能说明;输入，输出和返回值说明；调用关系和被调用关系描述等. 版本号(@version)可能不会出现在函数注释中.

注释模板1:

评论模板二:

5. 方法说明:

采用方法注释. 对于设置(Set方法)和获取(Get方法)成员的方法，在解释了成员变量后，不能添加任何注释；需要普通的成员方法来说明完成了什么功能，参数的含义是什么，返回值是什么；此外，必须清楚说明该方法的创建时间，以为将来的维护和阅读提供有价值的线索.

6. 该方法的内部注释:

控制结构，代码的功能以及执行的原因，处理顺序等. 尤其对于复杂的逻辑处理部分，应尽可能给出详细的注释.

7. 全局变量注释:

更详细的注释，包括对其功能，值范围，访问的功能或过程的说明，以及访问期间的注意事项等.

8. 局部(中间)变量注释:

必须对主要变量进行注释，如果没有特殊含义jsp代码注释，可以不加注释.

9. 实际参数/参数说明:

参数含义以及任何其他约束或前提条件.

10. 字段/属性注释: 字段描述，属性描述.

11. 常量: 常量通常具有一定的实际意义，必须定义相应的描述.

本文来自电脑杂谈，转载请注明本文网址：

http://www.pc-fly.com/a/jisuanjixue/article-254359-1.html