【转载】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的文档注释,也分享给大家,...
  • u011123714
  • u011123714
  • 2015年05月19日 17:18
  • 2449

Android 命名规范和编码规范(尽力简单,多写注释)

一、制定规范不需要太多的理论知识,只要记住两点就够了:尽力简单,多写注释 二、登录页面的登录按钮命名: login_button(资源文件) btnLogin(java代码中的按...
  • yaoming168
  • yaoming168
  • 2016年07月22日 19:40
  • 1335

android studio 学习笔记之 注释规范化

今天我们讲一下在android studio当中如何配置类注释和方法注释模板,让你的项目更加规范化,先来看看效果:新建一个类的注释效果:给一个方法的注释效果:下面来将下实现步骤吧:File ->Set...
  • qq_22063697
  • qq_22063697
  • 2016年05月08日 11:56
  • 9407

C/C++ 代码规范: 命名规则、注释、格式

摘抄精简Google 开源项目风格指南: http://zh-google-styleguide.readthedocs.org/en/latest/contents/ 一. 命名规则 永远不要使用单...
  • quzhongxin
  • quzhongxin
  • 2015年05月15日 10:08
  • 3002

java编程规范之java注释规范

代码要是没有注释,对读者来说就是一堆乱七八糟的字母,为了提高代码的可读性和可维护性,必须对代码进行必要的注释,这里小编整理了一下java注释规范。 (一)技巧    1:注释当前行快捷方式:ctr...
  • u012116457
  • u012116457
  • 2014年03月30日 17:47
  • 4230

iOS 代码注释规范

一、注释写法1.1 注释形式1.1.1 单行注释在很多时候只需写一个简要描述就够了,这时最好使用单行注释。推荐格式为// 简要描述.1.1.2 多行注释当需要写详细描述时,这时就需要使用多行注释了。推...
  • u010545480
  • u010545480
  • 2017年02月06日 10:38
  • 828

华为软件编程规范和范例 1 ——排版和注释

华为软件编程规范和范例 1. 排版 1.1    程序块要采用缩进风格编写, 缩进的空格数为4个。 说明: 对于由开发工具自动生成的代码可以有不一致。 1.2  ...
  • Cowena
  • Cowena
  • 2015年08月05日 10:35
  • 1311

手把手教你写_“华为”_的标准注释与文档,以及代码规范

为什么要写注释呢?为什么要写文档呢?  也许有人会这样问。但是我只想说如果你还在这样问,那么你不仅不是一个优秀的程序员,应该说你是不是程序员都应该受到质疑。 先说一下注释的重要性:  在公司...
  • zheng_guan
  • zheng_guan
  • 2016年11月20日 23:49
  • 4556

js/javascript代码注释规范与示例

注释在代码编写过程中的重要性,写代码超过半年的就能深深的体会到。没有注释的代码都不是好代码。为了别人学习,同时为了自己以后对代码进行‘升级’,看看js/JavaScript代码注释规范与示例。来自:h...
  • mrhaoxiaojun
  • mrhaoxiaojun
  • 2017年03月01日 15:19
  • 887

Javascript 代码注释规范

javascript 代码注释规范 注释一般来说是好事情,但新手编程经常犯错误。他们写注释解释“代码是什么”,但这样解释性注释应该越少越好。 严肃地说,好的代码应该容易理解无需注释。有个极好...
  • neweastsun
  • neweastsun
  • 2017年05月10日 12:17
  • 2385
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:【转载】android代码注释规范
举报原因:
原因补充:

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