【轉載】myeclipse自動生成註釋

在使用Eclipse編寫Java代碼時，自動生成的註釋信息都是按照預先設置好的格式生成的，例如其中author 的屬性值。

咱們能夠在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: zkyr</p>
* @author Uu
* @date ${date}
* @version 1.0
*/

 

 

類型註釋標籤（類的註釋）：

/**
* <p>Title: ${type_name}</p>
* <p>Description: </p>
* <p>Company: zkyr</p> 
* @author   Uu
* @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}
*/

 來自：http://blog.csdn.net/aaronuu/article/details/7065928