编码规范

1. 代码格式化设置：统一使用tab缩进，一个tab占用4个空格宽度，120字符换行。
2. 代码提交前必须进行格式化。
3. JAVA代码提交不允许出现红叉、尽量也不要出现警告。
4. [.classpath] [.project] [.git] [.idea] [.settings] [.iml] 等文件不允许提交。
5. Controller类名称去掉Controller这几个字符，并且首字母小写后，应该与访问地址中对应部分一致。
6. Controller中方法名称应该与访问地址中对应部分一致。（命名规范参考使用的开发平台（ade或jqde））
7. 在 if/else/for/while/do 语句中必须使用大括号，即使只有一行代码，避免使用下面的形式：

if (condition) statements;

8. 类、类属性、类方法的注释必须使用 javadoc 规范，使用【/**内容*/】格式，不得使用【//xxx】 方式。
9. 方法内部单行注释，在被注释语句上方另起一行，使用【//】注释。方法内部多行注释使用【/* 内容 */】注释，注意与代码对齐。
10. 注释内容
    a) 类注释需要说明该类的功能、创建者、创建时间
    b) 方法注释除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能
11. 推荐使用 try-with-resources管理资源

只要实现AutoCloseable接口的类都可以使用try-with-resources进行管理资源

12. Java中集合强制使用泛型【强烈建议】

13. 所有的覆写方法，必须加@Override 注解。
    反例：getObject()与 get0bject()的问题。一个是字母的 O，一个是数字的 0，加@Override可以准确判断是否覆盖成功。另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译报错。

14. 特殊注释标记 TODO、FIXME 【推荐使用】
    请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描，经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。
    1） 待办事宜（TODO）:（ 标记人，标记时间，[预计处理时间]）
    表示需要实现，但目前还未实现的功能。这实际上是一个 javadoc 的标签，目前的
    javadoc 还没有实现，但已经被广泛使用。只能应用于类，接口和方法（因为它是一个javadoc标签）。
    2） 错误，不能工作（FIXME）:（标记人，标记时间，[预计处理时间]）
    在注释中用 FIXME 标记某代码是错误的，而且不能工作，需要及时纠正的情况

示例如下：

以 eclipse 为例查看 Tasks 视图操作如下：

可以快速显示出项目中所有的TODO、FIXME标记。
eclipse 还支持自定义标记。

---

想了解更多精彩内容请关注我的公众号