Eclipse自動添加註釋模板

 

Eclipse使用自動註釋：在Eclipse工具的Window\preferences\JAVA\Code Style\Code templates\Comments下設置如下模版

 

文件(Files)註釋標籤

/**
 * @Title: ${file_name}
 * @Package: ${package_name}
 * @Description: ${todo}(用一句話描述該文件作什麼)
 * @author: ${user}
 * @date: ${date} ${time}
 * @最後修改人: ${user}
 * @最後修改時間: ${date} ${time}
 * @version: V1.0
 * @copyright: ASIAINFO
 */

　　特別說明：關於「${user}」配置，若是想配置成本身自定義的姓名，如：張三，則須要在eclipse/myeclipse的目錄下找到eclipse.ini/myeclipse.ini文件，在-vmargs後邊添加上啓動參數：-Duser.name=張三，並重啓myeclipse工具後「* @author ${user}」將改變爲「* @author  張三」。

 

類型(Types)註釋標籤（類的註釋）

/**    
 * @ClassName: ${type_name} 
 * @Description: ${todo}(這裏用一句話描述這個類的做用) 
 * @author: ${user}
 * @date: ${date} ${time}
 * @最後修改人: ${user}
 * @最後修改時間: ${date} ${time}
 * ${tags}
 */

 

字段(Fields)註釋標籤

/**
 * @Description: ${todo}(這裏用一句話描述這個類的做用) 
 * @Fields: ${field}
 */

 

構造函數標籤

/**
 * @Title: 構造函數
 * @Description: (描述構造函數實現的功能)
 * ${tags}
 */

 

方法(Constructor & Methods)標籤

/**    
 * @Title: ${enclosing_method} 
 * @Description: ${todo}(這裏用一句話描述這個方法的做用) 
 * @最後修改人: ${user}
 * @最後修改時間: ${date} ${time}
 * ${tags} 對方法的參數進行描述
 * @return: ${return_type} 返回類型
 * @throws
 */

 

覆蓋方法(Overriding Methods)標籤

/**     
 * @Title: ${enclosing_method}
 * @Description: ${todo}(這裏用一句話描述這個方法的做用)
 * @最後修改人: ${user}
 * @最後修改時間: ${date} ${time}
 * ${see_to_overridden}
 * ${tags} 對方法的參數進行描述
 * @throws
 */

 

代理方法(Delegate Methods)標籤

/**    
 * @Title: ${enclosing_method} 
 * @Description: ${todo}(這裏用一句話描述這個方法的做用) 
 * @最後修改人: ${user}
 * @最後修改時間: ${date} ${time}
 * ${see_to_target}
 * ${tags} 對方法的參數進行描述
 * @throws
 */

 

getter方法標籤

/**    
 * @Title: 返回 ${bare_field_name} 的值  
 * @return ${bare_field_name}
 */

 

setter方法標籤

/**    
 * @Title: 設置 ${bare_field_name} 的值
 * @param ${param} 參數設置變量 ${bare_field_name} 的值
 */

 

　　設置完成以後，能夠輸入/**而後回車就能夠自動添加註釋了。