1、背景簡介

豐富的註釋和良好的代碼規範，對於代碼的閱讀性和可維護性起着相當重要的做用。幾乎每一個公司對這的要求仍是比較嚴格的，每每會造成本身的一套編碼規範。可是再實施過程當中，若是全靠手動完成，不只效率低下，還難以保證真正的符合規範。因此結合IDE環境，自動生成註釋，仍是頗有必要的。今天咱們就說一下，如何使用Eclipse給咱們提供的自定義代碼模版的功能來做業。java

2、設置註釋模板

• 設置註釋模板的入口：Window->Preference->Java->Code Style->Code Templateeclipse

• 而後展開Comments節點就是全部需設置註釋的元素了！函數

• 一下修改，只須要點擊右側面板上的按鈕 – 編輯(Edit)， 即可修改爲本身的註釋！編碼

  
  

  這裏寫圖片描述

3、詳細介紹

一、文件(Files)註釋標籤

Files標籤是對新建的文件的說明，出如今文件最上面spa

• 推薦註釋風格：

/** * Copyright © ${year} eSunny Info. Tech Ltd. All rights reserved. * * 功能描述： * @Package: ${package_name} * @author: ${user} * @date: ${date} ${time} */

二、類型(Types)註釋標籤（類的註釋）

Types標籤是對類Class的一個說明，出如今類上面.net

• 推薦註釋風格：

/** * Copyright: Copyright (c) ${year} LanRu-Caifu * * @ClassName: ${file_name} * @Description: 該類的功能描述 * * @version: v1.0.0 * @author: ${user} * @date: ${date} ${time} * * Modification History: * Date Author Version Description *---------------------------------------------------------* * ${date} ${user} v1.0.0 修改緣由 */

三、字段(Fields)註釋標籤

Fields標籤是對變量字段的說明代碼規範

• 推薦註釋風格：

// @Fields ${field} : ${todo}

四、構造函數(Constructors)標籤

Constructors標籤是對類的構造函數的說明code

• 推薦註釋風格：

/** * @Function: ${file_name} * @Description: 該函數的功能描述 * * @param:參數描述 * @version: v1.0.0 * @author: ${user} * @date: ${date} ${time} */

五、方法(Methods)標籤

Methods標籤是對函數方法的說明blog

• 推薦註釋風格：

/** * @Function: ${file_name} * @Description: 該函數的功能描述 * * @param:描述1描述 * @return：返回結果描述 * @throws：異常描述 * * @version: v1.0.0 * @author: ${user} * @date: ${date} ${time} * * Modification History: * Date Author Version Description *---------------------------------------------------------* * ${date} ${user} v1.0.0 修改緣由 */

六、覆蓋方法(Overriding Methods)標籤

Overriding Methods標籤是對覆蓋方法的說明圖片

• 推薦註釋風格：

/** * ${see_to_overridden} * @Function: ${file_name} * @Description: 該函數的功能描述 * * @param:描述1描述 * @return：返回結果描述 * @throws：異常描述 * * @version: v1.0.0 * @author: ${user} * @date: ${date} ${time} * * Modification History: * Date Author Version Description *---------------------------------------------------------* * ${date} ${user} v1.0.0 修改緣由 */

七、表明方法(Delegate Methods)標籤

• 推薦註釋風格：

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

八、getter方法標籤

• 推薦註釋風格：

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

九、setter方法標籤

• 推薦註釋風格：

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

4、如何自動添加註釋

一、可經過以下三種方法自動添加註釋：

• 輸入「/**」並回車。
• 用快捷鍵 Alt＋Shift+J（先選中某個方法、類名或變量名）。
• 在右鍵菜單中選擇「Source > Generate ElementComment」。

二、新建文件或類的時候，怎麼自動生成文件(file)的註釋呢？

只須要勾選Automatically and comments for new methods and types便可！

三、導入/導出代碼格式模板

若是你辛辛苦苦定製好了本身的代碼風格，而後換了臺機器進行操做或重裝了Eclipse，是否是要從新配置一遍呢？答案固然是No了，Eclipse提供了「導出」和「導入」功能，你能夠把本身的模板導出來在其餘機器上使用。

5、建立自定義註釋模板

• eclipse自帶一些註釋模板，如日期(@date)、文件名(@ClassName)、做者(@author)等，那麼怎麼自定義一些註釋模板呢？