Android注释规范-白红宇

Android注释规范

阅读量：2085 次

发布时间：2019-04-29

本文共 396 字，大约阅读时间需要 1 分钟。

1、文件头注释（用/* */）

每个文件的文件头都必须做文件头注释，这样可以清楚地知道这个文件的作用。

2、方法头注释（用/* */）

每个成员方法的方法头都必须做方法头注释，这样在其他地方调用该方法的时候，不用看这个方法的具体内容，也知道这个方法的作用。

3、块注释（用//）

在一段阶段性功能的代码前做块注释，这样可以清楚地知道这段代码实现了什么样的功能。

4、变量注释（用//，注释在变量右侧）

在成员声明时，对其做功能注释，解释这个变量的用途。

5、语句注释（用//，注释在语句右侧）

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

6、有关注释的其它说明

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

（2）注释量必须不少于代码总量的三分之一；

参考资料链接：

转载地址：http://gssqf.baihongyu.com/

你可能感兴趣的文章