android 自己建立一個注釋模板作為一名程式員 不僅要有一個寫代碼的能力,養成一個良好的編寫習慣也是很重要的。今天給大家詳細介紹一下如何建立注釋模板,給每個類和方法都自己手動去注釋資訊也可以,只是這樣比較繁瑣。為何我們不手動去建立一個注釋模板呢?
第一: 首先我們需要編寫一個模板的xml檔案(codetemplates.xml)
第二、我們現在就給xml檔案編寫主要注釋的內容資訊,我就直接把自己用的xml資訊直接貼出來
/**
* @描述:
* @方法名: ${enclosing_method}
* ${tags}
* @建立人:${user}
* @建立時間:${date}${time}
* @修改人:${user}
* @修改時間:${date}${time}
* @修改備忘:
* @throws
*//**
* @描述:
* @方法名: ${enclosing_method}
* ${tags}
* @傳回型別 ${return_type}
* @建立人 ${user}
* @建立時間 ${date}${time}
* @修改人 ${user}
* @修改時間 ${date}${time}
* @修改備忘
* @since
* @throws
*//**
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*//**
* @param ${param} ${bare_field_name}
*//**
* ${tags}
* ${see_to_target}
*//**
* @return ${bare_field_name}
*//**
* @類描述:
* @項目名稱:${project_name}
* @包名: ${package_name}
* @類名稱:${type_name}
* @建立人:${user}
* @建立時間:${date}${time}
* @修改人:${user}
* @修改時間:${date}${time}
* @修改備忘:
* @version v1.0
* @see [nothing]
* @bug [nothing]
* @Copyright go3c
* @mail *@qq.com
*//**
* @標題: ${file_name}
* @包名: ${package_name}
* @功能描述:${todo}
* @作者: ${user}
* @建立時間: ${date} ${time}
* @version v1.0
*//**
* @欄位:${field}
* @功能描述:
* @建立人:${user}
* @建立時間:${date}${time}
*/
三、我們如何在eclipse中使用這個編寫好的xml檔案呢? 現在我就給大家解析一下吧! Window --> Preferences --> Java --> Code Style --> Code Templates --> Comments --> Import --> 選擇 codetemplates.xml --> OK 添加後可以自己修改郵箱地址。建立人名稱可以在eclipse目錄下的eclipse.ini 中增加一行 -Duser.name="whateveryouwant"。
四、我們在eclipse中如何快速使用我們寫好的注釋模組資訊呢? 添加註釋時在類名上輸入/**然後斷行符號就會自動產生如下格式注釋:
/**
*
* @類描述:
* @項目名稱:
* @包名:
* @類名稱:AppDao
* @建立人:
* @建立時間:2014-4-30上午10:32:30
* @修改人:
* @修改時間:2014-4-30上午10:32:30
* @修改備忘:
* @version v1.0
* @see [nothing]
* @bug [nothing]
* @Copyright
* @mail */
在方法名上輸入/**然後斷行符號就會自動產生如下格式注釋:
/**
*
* @描述:
* @方法名: UpdatePlayerHistory
* @param db
* @param item
* @return
* @傳回型別 int
* @建立人
* @建立時間 2014-4-30上午10:22:36
* @修改人
* @修改時間 2014-4-30上午10:22:36
* @修改備忘
* @since
* @throws
*/
描述內容需要自己手動填寫。
注意:本文章屬於原創,請尊重個人的勞動成果!謝謝!