1. 程式人生 > >開發工具Eclipse-程式碼註釋模板

開發工具Eclipse-程式碼註釋模板


點選選單Window->Preferences彈出首選項設定視窗
展開左側Java->Code Style->Code Template選項列表,就可以看到所有需設定註釋的元素了
展開右側模板選項Comments,可以看到可以設定的註釋模板型別,包含Files,Types,Fields,Constructors,Methods等內容

點選Types,下方Pattern區域會顯示類註釋模板內容,點選右則的Edit按鈕可以對註釋模板內容進行修改

 注意,這裡要勾選,表示在新建類時將時自動添加註釋資訊

在實際開發過程中,新建一個類以後,通過輸入/**,然後回車即自動按照剛才定義的註釋模板格式補齊註釋內容,也可以按shift+alt+j快捷鍵完成該動作

 

1.檔案(Files)註釋標籤

/**
 * Copyright (C) 2016-Now XXXX All rights reserved.
 * XXXX對本內容擁有著作權,禁止外洩,禁止未經授權使用。
 */

 

2.型別(Types)註釋標籤(類的註釋)

/**
 * <p>標題: ${type_name}</p>
 * <p>描述: </p>
 * <p>公司: XXXX www.xxxxxxxxx.com</p>
 * @author ${user}
 * @date ${date} ${time}
 * ${tags}
 */

 

3.欄位(Fields)註釋標籤

/**   
 * @Fields ${field} : ${todo}(用一句話描述這個變量表示什麼)   
 */ 

 

4.建構函式標籤

/**   
 * @Title:構造方法   
 * @Description:${todo}(這裡用一句話描述這個方法的作用)   
 * ${tags}
 */

 

5.方法(Methods)標籤

/**
 * ${todo}(這裡用一句話描述這個方法的作用) 
 * ${tags}
 */

 

6.覆蓋方法(Overriding Methods)標籤

/**   
 * <p>描述: ${todo}(這裡用一句話描述這個方法的作用) </p>   
 * ${tags}   
 * ${see_to_overridden}   
 */

 

7.代表方法(Delegate Methods)標籤

/**
 * ${tags}
 * ${see_to_target}
 */

 

8.getter方法標籤

/**
 * @return the ${bare_field_name}
 */

 

9.setter方法標籤

/**
 * @param ${param} the ${bare_field_name} to set
 */