導(dǎo)航

　　在使用Eclipse 編寫Java代碼時(shí)，自動(dòng)生成的注釋信息都是按照預(yù)先設(shè)置好的格式生成的，例如其中author 的屬性值。

我們可以在Eclipse 中進(jìn)行設(shè)置自己希望顯示的信息。

      現(xiàn)在看看如何修改我們的用戶名即作者信息：點(diǎn)擊Windows->Preferences->Java->Code Style->Code Templates,

           然后我們就可以選擇右邊窗口中的Comments，對應(yīng)具體的comments選項(xiàng)，我們便可以對具體的注釋信息進(jìn)行編輯設(shè)置。

例如我們希望在一個(gè)Java文件的開頭設(shè)置作者作者信息以及日期信息。

            選擇Types，點(diǎn)擊Edit，將

/**
  * @author ${user}
* ${tags}
*/  

將${user}刪除，改成hanyankai，這樣作者信息就變成hanyankai；點(diǎn)擊Insert Variable，選擇Date，這樣就會(huì)自動(dòng)生成日期信息。

      設(shè)置完以后我們測試一下，自動(dòng)生成的注釋信息為：

/**
* @author hanyankai

* 2009-11-27
*/

     同樣的步驟，我們也可以對其他例如構(gòu)造函數(shù)等等注釋信息進(jìn)行編輯設(shè)置。

    使用時(shí)鼠標(biāo)放置在需要添加注釋的方法內(nèi)部的任意位置。點(diǎn)擊菜單欄 中【源代碼】下的【添加 Javadoc 注釋】，或者使用快捷鍵 Alt Shift J ，則 eclipse 自動(dòng)在該方法前面添加注釋。

注釋的規(guī)范如下：

文件注釋標(biāo)簽：

/**
* <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
*/

類型注釋標(biāo)簽（類的注釋）：

/**
* <p>Title: ${type_name}</p>
* <p>Description: </p>
* <p>Company: LTGames</p>
* @author    linrz
* @date       ${date}
*/

字段注釋標(biāo)簽：

/** ${field}*/

構(gòu)造函數(shù)標(biāo)簽：

/**
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/

方法標(biāo)簽：

/**
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
*/

覆蓋方法標(biāo)簽：

/* （非 Javadoc）
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/

代表方法標(biāo)簽：

/**
* ${tags}
* ${see_to_target}
*/

getter方法標(biāo)簽：

/**
* @return ${bare_field_name}
*/

setter方法標(biāo)簽：

/**
* @param ${param} 要設(shè)置的 ${bare_field_name}
*/