编码规范（一）之Code Templates的设置

基于公司的主流开发工具为eclipse，但每个人都有自己的编码习惯，为了统一格式，这里通过三个方面：设置Code Templates、Checkstyle 、Eclipse formatter，来介绍下配置统一的编码风格。

 

一、Code Templates的设置

具体步骤如下：

打开Window->Preferences->Java->Code Style->Code Templates

点击import，导入模板文件huaxia_code_templates_v1.1.xml。

huaxia_code_templates_v1.1.xml内容是我事先定义好的，我们可以看到Eclipse Code Templates界面中间Configure generated code and comments区域包含了两个菜单树：Comment、Code，如下图所示：

 

 

Comments代表注释模板，Code代表代码模板，其中每一个子菜单代表子项的模板。

我们只要点击某一个子项，就会在界面下方的Pattern区域看到该项我们所定义的模板内容和格式，如下图所示：

 

如上图所示，当我们点击Comments下的子菜单时，下面的Pattern会显示Java文件的头部注释。

下面详细列出每一个子项的说明：

Comments-->Files（Java文件注释）

Comments-->Types（Java类注释）

Comments-->Fields（类字段注释）

Comments-->Constructors（构造函数注释）

Comments-->Methods（Java方法注释）

Comments-->Overriding methods（重写方法注释）

Comments-->Delegate methods（代理方法注释）

Comments-->Getters（Java Getter方法注释）

Comments-->Setters（Java Setters方法注释）

 

Code下的子菜单说明：

 

Code-->New Java files（新建java文件代码模板）  

Code-->Method body（方法体模板）

Code-->Constructor body（构造函数模板）

Code-->Getter body（字段Getter方法模板）

Code-->Setter body（字段Setter方法模板）

Code-->Catch block body（异常catch代码块模板）

 

 

 

设置Code Templates的目的主要是为了统一各种注释的格式以及代码的模板，只要设定好Code Templates之后利用Eclipse就可以方便地生成我们自定义的注释。