Eclipse中設定作者日期等資訊
我們可以在Eclipse 中進行設定自己希望顯示的資訊。
現在看看如何修改我們的使用者名稱即作者資訊:點選Windows->Preferences->Java->Code Style->Code Templates,
然後我們就可以選擇右邊視窗中的Comments,對應具體的comments選項,我們便可以對具體的註釋資訊進行編輯設定。
例如我們希望在一個Java檔案的開頭設定作者作者資訊以及日期資訊。
選擇Types,點選Edit,將
/**
* @author ${user}
* ${tags}
*/
將${user}刪除,改成hanyankai,這樣作者資訊就變成hanyankai;點選Insert Variable,選擇Date,這樣就會自動生成日期資訊。
設定完以後我們測試一下,自動生成的註釋資訊為:
/**
* @author hanyankai
* 2009-11-27
*/
同樣的步驟,我們也可以對其他例如建構函式等等註釋資訊進行編輯設定。
使用時滑鼠放置在需要添加註釋的方法內部的任意位置。點選選單欄 中【原始碼】下的【新增 Javadoc 註釋】,或者使用快捷鍵 Alt Shift J ,則 eclipse 自動在該方法前面添加註釋。
註釋的規範如下:
檔案註釋標籤:
/**
* <p>Title: ${file_name}</p>
* <p>Description: </p>
* <p>Copyright: Copyright (c) 2007</p>
* <p>Company: LTGames</p>
* @author linrz
* @date ${date}
* @version 1.0
*/
型別註釋標籤(類的註釋):
/**
* <p>Title: ${type_name}</p>
* <p>Description: </p>
* <p>Company: LTGames</p>
* @author linrz
* @date ${date}
*/
欄位註釋標籤:
/** ${field}*/
建構函式標籤:
/**
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/
方法標籤:
/**
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
*/
覆蓋方法標籤:
/* (非 Javadoc)
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/
代表方法標籤:
/**
* ${tags}
* ${see_to_target}
*/
getter方法標籤:
/**
* @return ${bare_field_name}
*/
setter方法標籤:
/**
* @param ${param} 要設定的 ${bare_field_name}
*/
