【转载】android代码注释规范

转载 2016年08月29日 22:10:34

1、 文件头注释

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

复制代码

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

 

 
复制代码

 

                       

2、 方法头注释

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

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

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

 

 

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

 

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

 

 

3、 块注释

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

 

 

 

4、 变量注释

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

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

 

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

 

 

5、 语句注释

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

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

 

 

6、 有关注释的其它说明

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

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


转自:http://www.cnblogs.com/SharkBin/p/3999804.html

相关文章推荐

Java&Android代码注释规范

一、注释及简介 1、鄙人写的一些代码中,虽说有注释,但都是一些不符合规则的注释,即便拿出来查阅,也要花很一些时间才能搞懂程序的流程。为了良好的编程风格,我特意学习了java的文档注释,也分享给大家,...

Android GPS代码有详细注释

  • 2014年08月18日 19:31
  • 1.29MB
  • 下载

Android Studio 配置系列(一):自定义代码注释

Android编程常用的注释模板
  • MC_bin
  • MC_bin
  • 2016年12月06日 14:58
  • 283

1.13Android 学习+进度之十三-删除冗余代码+注释+分析设计方法

终于到了,规范化代码的时候。第一步,把该删的删,命名也规范,加注释。 有个链接存一下,号称是新浪sdk的开发规范http://glblong.blog.51cto.com/3058613/16771...

Android 手势锁的实现 与详细的代码注释

先上图,默认效果图: 当然可以自定义数量啊,颜色神马的,自定义效果图: 如果你有艺术细胞,可以给我推荐几个颜色,无奈个人审美有问题~ ...

Android Studio 自定义注释&快速输入代码片段

在android studio 中自定义注释模板 快速输入注释,自定义代码片段,快捷键快速输入代码片段 一.设置类创建时自动生成头部注释 比如每次创建一个类自动在头部生成一个这样的头部...

android线程实现:实时显示所连接的wifi信号强度(代码带注释)

首先:AndroidManifest.xml文件中加一行:获取权限 layout.xml文件中的代码:
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:【转载】android代码注释规范
举报原因:
原因补充:

(最多只允许输入30个字)