【eclipse修改默認注釋】

 

一、背景簡介

豐富的注釋和良好的代碼規范，對於代碼的閱讀性和可維護性起着至關重要的作用。幾乎每個公司對這的要求還是比較嚴格的，往往會形成自己的一套編碼規范。但是再實施過程中，如果全靠手動完成，不僅效率低下，還難以保證真正的符合規范。所以結合IDE環境，自動生成注釋，還是很有必要的。今天我們就說一下，如何使用Eclipse給我們提供的自定義代碼模版的功能來作業。

二、設置注釋模板

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

• 然后展開Comments節點就是所有需設置注釋的元素了！

• 一下修改，只需要點擊右側面板上的按鈕 – 編輯(Edit)， 便可修改成自己的注釋！

  
  

  這里寫圖片描述

三、詳細介紹

1、文件(Files)注釋標簽

Files標簽是對新建的文件的說明，出現在文件最上面

• 推薦注釋風格：

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

2、類型(Types)注釋標簽（類的注釋）

Types標簽是對類Class的一個說明，出現在類上面

• 推薦注釋風格：

/** * 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 修改原因 */

3、字段(Fields)注釋標簽

Fields標簽是對變量字段的說明

• 推薦注釋風格：

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

4、構造函數(Constructors)標簽

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

• 推薦注釋風格：

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

5、方法(Methods)標簽

Methods標簽是對函數方法的說明

• 推薦注釋風格：

/** * @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 修改原因 */

6、覆蓋方法(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 修改原因 */

7、代表方法(Delegate Methods)標簽

• 推薦注釋風格：

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

8、getter方法標簽

• 推薦注釋風格：

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

9、setter方法標簽

• 推薦注釋風格：

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

四、如何自動添加注釋

1、可通過如下三種方法自動添加注釋：

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

2、新建文件或類的時候，怎么自動生成文件(file)的注釋呢？

這里寫圖片描述

只需要勾選Automatically and comments for new methods and types即可！

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

如果你辛辛苦苦定制好了自己的代碼風格，然后換了台機器進行操作或重裝了Eclipse，是不是要重新配置一遍呢？答案當然是No了，Eclipse提供了“導出”和“導入”功能，你可以把自己的模板導出來在其他機器上使用。

這里寫圖片描述

五、創建自定義注釋模板

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