Java和Android注释规范
来源:互联网 发布:wlan网络是什么 编辑:程序博客网 时间:2024/05/17 03:15
1、 文件头注释
每一个文件的文件头都必须做文件头注释。文件头注释范例如下:
/** 文件名:LoginActivity* 描 述:对用户* 作 者:* 时 间:* 版 权:*/
2、 方法头注释
每一个成员方法(包括自定义成员方法、覆盖方法、属性方法)的方法头都必须做方法头注释。
自定义成员方法注释范例如下:
/*
* 方法名:login_Click(View v)
* 功 能:单击登录按钮的事件
* 参 数:View v - 按钮的View
* 返回值:无
*/
覆盖(重写)成员方法注释范例如下:
属性getter和setter成员方法注释范例如下:
3、 块注释
在实现一段阶段性功能的代码前做块注释。块注释的注释范例如下:
4、 变量注释
所有的成员变量和大多数局部变量在声明时都需要为其做功能注释。
成员变量注释的注释范例如下:
局部变量注释的注释范例如下:
5、 语句注释
在关键语句的右侧要做单条语句注释。
语句注释的注释范例如下:
6、 有关注释的其它说明
(1) 文件头和方法头注释应该使用/**/形式,变量注释和语句注释应该使用//形式,块注释应尽量使用//形式,当文字较长(单屏横向不能显示完全)时块注释也可以使用/**/形式;
(2) 注释量必须不少于代码总量的三分之一;
0 0
- Java和Android注释规范
- Java和Android注释规范
- Java和Android注释规范
- Java和Android注释规范
- Java和Android注释规范
- Java和Android注释规范
- Java&Android代码注释规范
- java快捷键和注释规范
- java编码规范_缩进和注释
- java编码规范和代码注释
- Java中的注释和命名规范
- java 学习2—命名规范和注释规范
- Android的注释规范
- Android注释规范
- android开发注释规范
- java注释规范
- Java注释规范
- Java注释规范
- CAShapeLayer 其他有用的层
- python numpy教程
- C语言的一个二叉树
- 日期时间对话框
- 作为一个新人,怎样学习嵌入式Linux?被问过太多次,特写这
- Java和Android注释规范
- Android中pendingIntent的深入理解
- 【微软100题】003求子数组的最大和
- mp4文件moov atom放置在mdat atom之前 代码实现
- php反射的使用
- 基于Bmob后台的AutoBank安卓客户端(实习最后两天)
- 计算二进制中1的个数和0的个数
- Android—Listview优化的几种方法
- android 事件分发 ViewGroup