android 自己創建一個注釋模板
作為一名程序員 不僅要有一個寫代碼的能力,養成一個良好的編寫習慣也是很重要的。今天給大家詳細介紹一下如何創建注釋模板,給每個類和方法都自己手動去注釋信息也可以,只是這樣比較繁瑣。為何我們不手動去創建一個注釋模板呢?
第一: 首先我們需要編寫一個模板的xml文件(codetemplates.xml)
第二、我們現在就給xml文件編寫主要注釋的內容信息,我就直接把自己用的xml信息直接貼出來
三、我們如何在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
*/
描述內容需要自己手動填寫。
注意:本文章屬於原創,請尊重個人的勞動成果!謝謝!