Java和Android注释规范

时间:2023-03-08 18:35:07

1、 文件头注释

每一个文件的文件头都必须做文件头注释。文件头注释范例如下:


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

 

Java和Android注释规范

2、 方法头注释

每一个成员方法(包括自定义成员方法、覆盖方法、属性方法)的方法头都必须做方法头注释。

自定义成员方法注释范例如下:

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

Java和Android注释规范

覆盖(重写)成员方法注释范例如下:

Java和Android注释规范

属性getter和setter成员方法注释范例如下:

Java和Android注释规范

3、 块注释

在实现一段阶段性功能的代码前做块注释。块注释的注释范例如下:

Java和Android注释规范

4、 变量注释

所有的成员变量和大多数局部变量在声明时都需要为其做功能注释。

成员变量注释的注释范例如下:

Java和Android注释规范

局部变量注释的注释范例如下:

Java和Android注释规范

5、 语句注释

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

语句注释的注释范例如下:

Java和Android注释规范

6、 有关注释的其它说明

(1)   文件头和方法头注释应该使用/**/形式,变量注释和语句注释应该使用//形式,块注释应尽量使用//形式,当文字较长(单屏横向不能显示完全)时块注释也可以使用/**/形式;

(2)   注释量必须不少于代码总量的三分之一;