一、背景簡介

豐富的註釋和良好的程式碼規範，對於程式碼的閱讀性和可維護性起著至關重要的作用。幾乎每個公司對這的要求還是比較嚴格的，往往會形成自己的一套編碼規範。但是再實施過程中，如果全靠手動完成，不僅效率低下，還難以保證真正的符合規範。所以結合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)等，那麼怎麼自定義一些註釋模板呢？