Eclipse中設定注釋、日期等資訊

標籤：

     在使用Eclipse 編寫Java代碼時，自動產生的注釋資訊都是按照預先設定好的格式產生的，例如其中author,datetime等屬性值。

我們可以在Eclipse 中進行設定自己希望顯示的注釋資訊。

      操作如下：點擊Windows->Preferences->Java->Code Style->Code Templates, 在右邊有個的comments選項， 我們就可以在裡面編輯相關的注釋資訊。

例如我們希望在一個Java檔案的開頭設定作者作者資訊以及日期資訊。

  選擇Types，點擊Edit，將

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

將${user}替換為vkzhang，這樣作者資訊就變成vkzhang；點擊Insert Variable，選擇Date，這樣就會自動產生日期資訊。

設定完以後我們測試一下，自動產生的注釋資訊為：

/**
* @author vkzhang

* 2015-2-2
*/

    同樣，在comments下還有Files,Methods,delegate methods等屬性，可以供我們一一設定,具體注釋的規範如下：

檔案注釋標籤：

/**
* <p>Title: ${file_name}</p>
* <p>Description: </p>
* <p>Copyright: Copyright (c) 2007</p>
* <p>Company: LTGames</p>
* @author vkzhang
* @date ${date}
* @version 1.0
*/

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

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

 

  當我們要在某個位置添加註釋時，點擊功能表列 中【原始碼】下的【添加 Javadoc 注釋】，或者使用快速鍵 Alt+Shift+J ， Eclipse 就會自動在該方法前面添加註釋。

Eclipse中設定注釋、日期等資訊