编码规范（三）之Eclipse formatter配置

一、三、Eclipse formatter配置

 

1、在Eclipse中点击Window -> Preferences菜单，点击左侧的Java->Code Style->Formatter，界面如下图所示：

 

Eclipse有自带的formatter模板，当然也可以点击上图的Import按钮，弹出格式化模板文件选择框，选择代码格式化文件，再点击下方的“Apply”按钮应用该模板文件，而后点击OK按钮完成设置。

 

在格式化文件中定义了很多Java格式化规范，例如：

<setting id="org.eclipse.jdt.core.formatter.lineSplit" value="150"/>

上行用于设置格式化时在一行达到150个字符（包括空格）时需要换行。

又如：

<setting id="org.eclipse.jdt.core.formatter.tabulation.size" value="4"/>

上行表示格式化时使用4个空格代替tab键。

 

2、配置使用4个空格代替tab键

在Eclipse中点击Window -> Preferences菜单，点击左侧的General->Editors->Text Editors，界面如下图所示：

 

在上图中勾选Insert spaces for tabs（使用空格代替tab键），并设置Displayed tab width为4（即使用4个空格代替tab键）。

 

3、设置不格式化代码注释

进行代码格式化时，会将代码注释也进行格式化，引起格式错乱，为避免其对注释进行格式化，采用的方法为：点击Window -> Preferences->Java->Code Style-> Formatter菜单，在右侧选中模板后点击Edit按钮，在弹出的界面中选择Comments的tab，如下图所示：

 

在上图中对红色区域的复选框取消勾选，这时候OK按钮会变灰掉，只需要重新修改下Profile name的名称即可确认保存。

 

4、使用模板进行格式化

  若要对某个文件进行格式化，可使用如下几种方法：

1） 打开文件后，在代码区域采用“CTRL + SHIFT + F”快捷键；

2） 打开文件后，在代码区域点击右键选择“Source”->“Format”功能。

3）Window -> Preferences->Java->Editor->Save Actions,勾选Perform the selected actions on save实现保存后自动format，但是这种方式可能会在修改过别人的代码后，以你的format方式格式化了别人的代码，当然如果整个项目组甚至公司都采用同样的fromat方式，可以最低限度的降低这种情况的发生。

 

 

编码规范一二三用到的配置文件样例见附件rar