编码规范

索引

注释

类、类属性、类方法的注释应该使用 Javadoc 规范。

与其“半吊子”英文来注释，不如用中文注释把问题说清楚。

注释的目的：

1. 能够准确反应设计思想和代码逻辑;
2. 能够描述业务含义，使别的程序员能够迅速了解到代码背后的信息。
3. 完全没有注释的大段代码对于阅读者形同天书，注释是给自己看的，即使隔很长时间，也能清晰理解当时的思路;注释也是给继任者看的，使其能够快速接替自己的工作。

特殊注释标记:

1. TODO : 待办事宜，注释内容应包含( 标记人，标记时间，[预计处理时间])
2. FIXME : 错误，不能工作，注释内容应包含(标记人，标记时间，[预计处理时间])