JAVA开发之 12-JAVA中的注释规范

JAVA注释方法及格式
1、单行(single-line)–短注释：//……
单独行注释：在代码中单起一行注释， 注释前最好有一行空行，并与其后的代码具有一样的缩进层级。如果单行无法完成，则应采用块注释。
注释格式：/* 注释内容 */
行头注释：在代码行的开头进行注释。主要为了使该行代码失去意义。
注释格式：// 注释内容

行尾注释：尾端(trailing)–极短的注释，在代码行的行尾进行注释。一般与代码行后空8（至少4）个格，所有注释必须对齐。
注释格式：代码 + 8（至少4）个空格 + // 注释内容
2、块(block)–块注释：/……/
注释若干行，通常用于提供文件、方法、数据结构等的意义与用途的说明，或者算法的描述。一般位于一个文件或者一个方法的前面，起到引导的作用，也可以根据需要放在合适的位置。这种域注释不会出现在HTML报告中。注释格式通常写成：
/*
* 注释内容
*/
3、文档注释：/……/*
注释若干行，并写入javadoc文档。每个文档注释都会被置于注释定界符
/*……/之中，注释文档将用来生成HTML格式的代码报告，所以注释文
档必须书写在类、域、构造函数、方法，以及字段(field)定义之前。注释文档由两部分组成——描述、块标记。注释文档的格式如下：
/**
* The doGet method of the servlet.
* This method is called when a form has its tag value method
* equals to get.
* @param request
* the request send by the client to the server
* @param response
* the response send by the server to the client
* @throws ServletException
* if an error occurred
* @throws IOException
* if an error occurred
*/
public void doGet (HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
doPost(request, response);
}
前两行为描述，描述完毕后，由@符号起头为块标记注释。更多有关文档注
释和javadoc的详细资料，参见javadoc的主页： http://java.sun.com/javadoc/index.html
4、javadoc注释标签语法
@author 对类的说明 标明开发该类模块的作者
@version 对类的说明 标明该类模块的版本
@see 对类、属性、方法的说明 参考转向，也就是相关主题
@param 对方法的说明 对方法中某参数的说明
@return 对方法的说明 对方法返回值的说明
@exception 对方法的说明 对方法可能抛出的异常进行说明
*JAVA注释具体实现*
1、源文件注释
源文件注释采用 /* …… /，在每个源文件的头部要有必要的注释信息，包括：文件名；文件编号；版本号；作者；创建时间；文件描述包括本文件历史修改记录等。中文注释模版：
/**
* 文 件 名 :
* CopyRright (c) 2008-xxxx:
* 文件编号：
* 创 建 人：
* 日 期：
* 修 改 人：
* 日 期：
* 描 述：
* 版 本 号：
*/
2、类（模块）注释：
类（模块）注释采用 /** ……
*/，在每个类（模块）的头部要有必要的注释信息，包括：工程名；类（模块）编号；命名空间；类可以运行的JDK版本；版本号；作者；创建时间；类（模
块）功能描述（如功能、主要算法、内部各部分之间的关系、该类与其类的关系等，必要时还要有一些如特别的软硬件要求等说明）；主要函数或过程清单及本类
（模块）历史修改记录等。
英文注释模版：
/**
* CopyRright (c)2008-xxxx:
* Project:
* Module ID:
* Comments:
* JDK version used:
* Namespace:
* Author：
* Create Date：
* Modified By：
* Modified Date:
* Why & What is modified
* Version:
*/
如果模块只进行部分少量代码的修改时，则每次修改须添加以下注释：
//Rewriter
//Rewrite Date： Start1：
/* 原代码内容*/
//End1：
将原代码内容注释掉，然后添加新代码使用以下注释：
//Added by
//Add date： Start2：
//End2：
如果模块输入输出参数或功能结构有较大修改，则每次修改必须添加以下
注释：
//Log ID：
//Depiction：
//Writer：修改者中文名
//Rewrite Date：
3、接口注释：
接口注释采用 /* …… /，在满足类注释的基础之上，接口注释应该包含描述接口的目的、它应如何被使用以及如何不被使用，块标记部分必须注明作者和版本。在接口注释清楚的前提下对应的实现类可以不加注释。
4、构造函数注释：
构造函数注释采用 /* …… /，描述部分注明构造函数的作用，不一定有块标记部分。
注释模版一：
/**
* 默认构造函数
*/
注释模版二：
/**
* Description : 带参数构造函数,
* 初始化模式名,名称和数据源类型
* @param schema： 模式名
* @param name： 名称
* @param type： 数据源类型
*/
5、函数注释：
函数注释采用 /* ……/，在每个函数或者过程的前面要有必要的注释信息，包括：函数或过程名称；功能描述；输入、输出及返回值说明；调用关系及被调用关系说明等。函数注释里面可以不出现版本号（@version）。
注释模版一：
/**
* 函 数 名 :
* 功能描述：
* 输入参数:
*
*
* 返 回 值: - 类型
*
* 异 常：
* 创 建 人:
* 日 期:
* 修 改 人:
* 日 期:
*/
注释模版二：
/**
* FunName: getFirstSpell
* Description : 获取汉字拼音首字母的字符串，
* 被生成百家姓函数调用
* @param： str the String是包含汉字的字符串
* @return String：汉字返回拼音首字母字符串；
* 英文字母返回对应的大写字母；
* 其他非简体汉字返回 ‘0’；
* @Author: ghc
* @Create Date: 2008-07-02
*/
6、方法注释：
方法注释采用 /* …… /，对于设置 (Set 方法 ) 与获取 (Get 方法 )
成员的方法，在成员变量已有说明的情况下，可以不加注释；普通成员方法要求说明完成什么功能，参数含义是什么且返回值什么；另外方法的创建时间必须注释清
楚，为将来的维护和阅读提供宝贵线索。
7、方法内部注释：
控制结构，代码做了些什么以及为什么这样做，处理顺序等，特别是复杂的逻辑处理部分，要尽可能的给出详细的注释。

8、全局变量注释：
要有较详细的注释，包括对其功能、取值范围、哪些函数或者过程存取以及存取时注意事项等的说明。
9、局部（中间）变量注释：
主要变量必须有注释，无特别意义的情况下可以不加注释。
10、实参/参数注释：
参数含义、及其它任何约束或前提条件。
11、字段/属性注释：
字段描述，属性说明。
12、常量：
常量通常具有一定的实际意义，要定义相应说明。