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、配置代碼格式化模板

EclipseMyEclipse中點擊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、編輯器(例如EditPlusUltraEdit等)中使用的空格數不同,因此爲了統一,開發人員統一使用4個空格代替tab鍵(checkstyle會配置做相應檢查)。

EclipseMyEclipse中點擊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”快捷鍵。

發佈了32 篇原創文章 · 獲贊 10 · 訪問量 2萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章