Java和Android注释规范
浏览数：30 /
时间：2015年06月11日
1、 文件头注释
每一个文件的文件头都必须做文件头注释。文件头注释范例如下：
1 /* 2 * 文件名：LoginActivity 3 * 描 述：对用户 4 * 作 者： 5 * 时 间： 6 * 版 权： 7 */
2、 方法头注释
每一个成员方法（包括自定义成员方法、覆盖方法、属性方法）的方法头都必须做方法头注释。
自定义成员方法注释范例如下：
1 /* 2 * 方法名：login_Click(View v) 3 * 功 能：单击登录按钮的事件 4 * 参 数：View v - 按钮的View 5 * 返回值：无 6 */
覆盖（重写）成员方法注释范例如下：
属性getter和setter成员方法注释范例如下：
3、 块注释
在实现一段阶段性功能的代码前做块注释。块注释的注释范例如下：
4、 变量注释
所有的成员变量和大多数局部变量在声明时都需要为其做功能注释。
成员变量注释的注释范例如下：
局部变量注释的注释范例如下：
5、 语句注释
在关键语句的右侧要做单条语句注释。
语句注释的注释范例如下：
6、 有关注释的其它说明
（1） 文件头和方法头注释应该使用/**/形式，变量注释和语句注释应该使用//形式，块注释应尽量使用//形式，当文字较长（单屏横向不能显示完全）时块注释也可以使用/**/形式；
（2） 注释量必须不少于代码总量的三分之一；
郑重声明：本站内容如果来自互联网及其他传播媒体，其版权均属原媒体及文章作者所有。转载目的在于传递更多信息及用于网络分享，并不代表本站赞同其观点和对其真实性负责，也不构成任何其他建议。
