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 就會自動在該方法前面添加注釋。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM