Eclipse编译器之 设置注释

1、配置统一的编码模板

1.1、eclipse设置java文件中的注释：

设置路径：

Window->Preference ->Java -> Code Style -> Code Templates->Comments

 

文件注释定义
Files
/**
* ${package_name}
* ${file_name}
* ${date}-${time}
* ${year}《版权名》-版权所有
*/

 

文件注释

Types:
/**
 * @file ${file_name}
 * @author 作者名</a>
 * @date ${date}${time}
 * @version 1.0

 */Window->Preference ->Java -> Code Style -> Code Templates->Coad->Class body
类版本注释:
public final static String CLASS_VERSION = "$$Id: ${file_name},v 1.0 ${date},${time}  $$";

快捷键shift+alt+j

1.2、使用编码模板

在创建类时，勾选如下页面的“Generate comments”选项，将会使新创建的类具有文件注释和类注释：    
     

2、配置统一的代码格式化模板

2.1、配置代码格式化模板

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

点击上图的“Import”按钮，弹出格式化模板文件选择框，选择代码格式化文件，例如eclipse_formatter-profile.xml文件（仅提供参考，可自行定义）。点击下方的“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键。

有兴趣的人可以查看《eip_eclipse_formatter-profile.xml》文件的内容。

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

tab键在不同的IDE、编辑器（例如EditPlus、UltraEdit等）中使用的空格数不同，因此为了统一，开发人员统一使用4个空格代替tab键（checkstyle会配置做相应检查）。

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

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

2.3 去掉对代码注释的格式化

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

         在上图中对红色区域的复选框取消勾选。

2.4 使用模板进行格式化

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

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

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

    【说明】建议采用“CTRL + Shift + F”快捷键。