Java和Android注释规范

一、 文件头注释

每个文件的文件头都必须作文件头注释。文件头注释范例以下：

/*
* 文件名：LoginActivity
* 描    述：对用户
* 做    者：
* 时    间：
* 版    权：
*/

 

 

                       

二、 方法头注释

每个成员方法（包括自定义成员方法、覆盖方法、属性方法）的方法头都必须作方法头注释。

自定义成员方法注释范例以下：

/*
 * 方法名：login_Click(View v)
 * 功    能：单击登陆按钮的事件
 * 参    数：View v - 按钮的View
 * 返回值：无
 */

 

 

覆盖（重写）成员方法注释范例以下：

 

属性getter和setter成员方法注释范例以下： 

 

 

三、 块注释

在实现一段阶段性功能的代码前作块注释。块注释的注释范例以下：

 

 

 

四、 变量注释

全部的成员变量和大多数局部变量在声明时都须要为其作功能注释。

成员变量注释的注释范例以下：

 

局部变量注释的注释范例以下：

 

 

五、 语句注释

在关键语句的右侧要作单条语句注释。

语句注释的注释范例以下：

 

 

六、 有关注释的其它说明

（1）   文件头和方法头注释应该使用/**/形式，变量注释和语句注释应该使用//形式，块注释应尽可能使用//形式，当文字较长（单屏横向不能显示彻底）时块注释也可使用/**/形式；

（2）   注释量必须很多于代码总量的三分之一；