JAVA 注释方法及格式
1、单行(single-line)--短注释://……
单独行注释:在代码中单起一行注释, 注释前最好有一行空行,并与其后的代码具有一
样的缩进层级。如果单行无法完成,则应采用块注释。
注释格式:/* 注释内容 */
行头注释:在代码行的开头进行注释。主要为了使该行代码失去意义。
注释格式:// 注释内容
行尾注释:尾端(trailing)--极短的注释,在代码行的行尾进行注释。一般与代码行后空
8(至少 4)个格,所有注释必须对齐。
注释格式:代码 + 8(至少 4)个空格 + // 注释内容
2、块(block)--块注释:/*……*/
注释若干行,通常用于提供文件、方法、数据结构等的意义与用途的说明,或者算法的描
述。一般位于一个文件或者一个方法的前面,起到引导的作用,也可以根据需要放在合适
的位置。这种域注释不会出现在 HTML 报告中。注释格式通常写成:
/*
* 注释内容
*/
3、文档注释:/**……*/
注释若干行,并写入 javadoc 文档。每个文档注释都会被置于注释定界符 /**......*/之中,
注释文档将用来生成 HTML 格式的代码报告,所以注释文档必须书写在类、域、构造函数、
方法,以及字段('eld)定义之前
4、javadoc 注释标签语法
@author 对类的说明 标明开发该类模块的作者
@version 对类的说明 标明该类模块的版本
@see 对类、属性、方法的说明 参考转向,也就是相关主题
@param 对方法的说明 对方法中某参数的说明
@return 对方法的说明 对方法返回值的说明
@exception 对方法的说明 对方法可能抛出的异常进行说明
六、JAVA 注释具体实现
1、源文件注释
源文件注释采用 /** …… */,在每个源文件的头部要有必要的注释信息,包括:文件名;
文件编号;版本号;作者;创建时间;文件描述包括本文件历史修改记录等。中文注释模
版:
/**
* 文 件 名 :