Eclipse中設置作者日期等Java注釋模板


Eclipse作為JavaIDE(Integrated Development Environment,集成開發環境),可以通過設置自動添加Javadoc注釋信息,如@author 作者名、@version 版本標識、@date 日期等,在創建類或新增方法時會自動添加注釋信息。關於java如何生成javadoc文檔可參考下文。下面將會為大家介紹如何在Eclipse中設置Java注釋模板。

 首先介紹幾個常用的注解:

@author 作者名

@date 日期

@version 版本標識

@parameter 參數及其意義

@return 返回值

@throws 異常類及拋出條件

@deprecated 引起不推薦使用的警告

@override 重寫

這個注解我們在java代碼中經常可以看到。

  1.  
  2. Eclipse中設置作者日期等Java注釋模板
  3.  

    點擊Edit按鈕,進入編輯頁面,全部編輯完成后點擊“Apply And Close”即可設置完成,並關閉設置頁面。

    Eclipse中設置作者日期等Java注釋模板
    Eclipse中設置作者日期等Java注釋模板
  4.  

    下面介紹具體的Comment如何設置:

    1. 點擊Comments下的Files可對整個Java文件進行注釋:包括公司名稱,版權所屬,作者信息,日期等。

     

    /**  

    * <p>Title: ${file_name}</p>  

    * <p>Description: </p>  

    * <p>Copyright: Copyright (c) 2017</p>  

    * <p>Company: www.baidudu.com</p>  

    * @author shenlan  

    * @date ${date}  

    * @version 1.0  

    */  

  5.  

    2. 點擊Types對類進行注釋:

     

    /**  

    * <p>Title: ${type_name}</p>  

    * <p>Description: </p>  

    * @author shenlan  

    * @date ${date}  

    */  

    3. 點擊Fields對字段進行注釋:

    /** ${field}*/  

    4. 點擊Constructors對構造方法進行注釋:

    /**  

    * <p>Title: </p>  

    * <p>Description: </p>  

    * ${tags}  

    */  

    5. 點擊Methods對方法進行注釋:

    /**  

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

     * <p>Description: </p>  

     * ${tags}  

     */  

  6.  

    6. 點擊Overriding Methods對重寫方法進行注釋:

    /* (non-Javadoc)  

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

     * <p>Description: </p>  

     * ${tags}  

     * ${see_to_overridden}  

     */

    7. Delegate methods對代表方法進行注釋:

    /**  

    * ${tags}  

    * ${see_to_target}  

    */

    8. Getters對get方法進行注釋:

    /**

     * @return the ${bare_field_name}  

     */

    9. Setters對set方法進行注釋:

    /**

     * @param ${param} the ${bare_field_name} to set  

     */

  7.  

    注釋模板的導入和導出:點擊Import和Export按鈕即可。

    Eclipse中設置作者日期等Java注釋模板
  8. 在設置模板時如果勾選了自動添加注釋信息,則在創建Java文件時會自動生成文檔和類的注釋信息,若沒有勾選,按Shift+Alt+J快捷鍵也可生成。
  9. 在對類中的方法進行注釋是:在方法上方輸入/** 后點擊回車,即可生成方法注釋;或將光標放在方法名上,按住Shift+Alt+J快捷鍵也可;或在方法上右擊,source》Generate Element Comment也可生成注釋。


免責聲明!

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



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