自定义代码注释规范

这里我简单定义一下代码及注释的格式规范。代码及注释的格式是显示一个项目是否合格的一个参考标准，也是决定项目能否进行到底的一个重要因素。着眼于细节，才能从量变到质变。所以请务必认真对待这个问题。

这是大体的图。简要说几点：

1、每一个类，每一个方法都要有注释。类的注释要在开始简单介绍一下类的功能，作用，目的等。函数的注释在开始要简单介绍一下函数的功能和目的等。已用TODO标出。函数还要加上每一个参数的说明和返回值的说明；

2、类属性如需注释，则直接使用单行注释；注意双斜杠之前要加空格。属性和方法之间使用空行分割。其他地方尽量不要再使用空行，包括方法之间。

3、每一个类的注释中有一个最近修改时间，尽量在每次submit之前，能够修改一下，方便以后作参考。

4、变量和函数的命名都严格采用驼峰命名法；static final依旧使用纯大写表示；函数的参数之间，记得使用空格分隔；大括号的格式尽量按照图中的方式；其他的操作符的规范不再赘述。

5、由于我们水平有限，尽量不要把一个类写的太大太复杂，能拆分，尽量拆分出来，这样方便别人参考，也容易维护。

以上的注释模板，如下所示：

/**
 * 作者：Yelbosh on ${DATE} ${HOUR}:${MINUTE}
 * 邮箱：yelbosh@foxmail.com
 * 描述：TODO
 * 最近修改：${DATE} ${HOUR}:${MINUTE} by Yelbosh
 */

直接将其覆盖File Header即可，函数的注释模板使用的是默认的模板。Android studio中如何修改注释模板，请自行百度。我还修改了注释快捷键，使用更加方便。