-
类，类属性，类方法的注视必须使用javadoc规范，使用/** 内容 **/格式，不得使用// xxx方式（在IDE中利用javadoc的语法．可以提示信息，提高阅读的效率）．
-
所有的抽象方法（包括接口中的方法）必须要用javadoc注释，除了返回值，参数，异常说明外，还必须指出该方法做什么事情，实现什么功能．
注：对于子类的实现要求，或者在调用的时候的注意事项，请一并说明．
-
所有的类都必须添加创建者和创建日期．
-
方法内部使用单行注释，在被注释的上方另起一行，使用//注释．方法内部多行注释使用/* */注释，注意与代码对齐．
-
所有的枚举类型字段必须要有注释，说明每个数据项的用途．
-
全部使用英文注释，防止出现编码的问题．
-
代码修改的同时，注释也要进行相应的修改，尤其是参数，返回值，异常，核心逻辑等的修改（代码与注释是一体的，如果不同步更新，会导致后期维护时的难以理解的困难）．
-
谨慎注释代码.详细说明注释的原因，如果没有用要果断的删除．
注释掉代码的原因无外乎：1. 后续可能会恢复此代码的逻辑（需要注释原因表明以后的意图） 2. 永久不用．没有备注的注释掉的代码属于垃圾，严重分散我们的注意力，请删除(代码仓库中回顾历史应该可以看到，也不用着急)．
-
对于注释的要求：第一，能够准确反应设计思想和代码逻辑;第二，能够描述业务含义，使别的程序员能够迅速了解到代码的含义．大段的没有注释的复杂的代码是天书，注释是给自己看的，也是给别人看的．
-
好的命名，代码结构是自注释的，力求精简准确，表达到位．切记冗杂．
-
特殊的注释标记，请注明标记人和标记的时间．注意即时处理这些标记，通过标记扫描，经常清理此类的标记，线上故障有时候就是来源于这些标记处的代码．
- //todo,在AndroidStudio上可以用到，请注明标记人和标记时间．以及何时会进行处理．
- 标记有错误的代码，在下一版本中进行修改,如果当前改动，可能会引起问题．
网友评论