一、爲何配置註釋模板
在工作中我們需要在必要的地方添加註釋以便於自己和其他人理解代碼，這就是註釋的主要功能，我們不希望發生幾個月後只有上帝知道我們的代碼是什麼意思的情況，那將充分的證明代碼不夠優雅。
二、模板的內容是什麼
模板的內容取決於我們自己或公司的註釋規範，註釋變化萬千，但是我認爲核心問題就是兩個
- 精簡且準確的描述代碼的功能、作用、意義、注意事項等，這是最基本的要求
- 公司對註釋的要求
三、如何配置
Eclipse 中提供了註釋模板的功能，簡單的配置之後就可以自定義所有註釋的樣式和內容，這種一勞永逸的事，還是有必要嘗試一下的。
首先打開Eclipse ，依次點擊
Window ——> Preference
java ——> Code Style ——> CodeTemplates ——> Comments
即可看見模板的配置窗口
我們可以嘗試選擇一個 ，比如點擊 Files 然後點擊 Edit ，即可看見模板配置的窗口
這裏就是我們配置的地方，在配置之前，需要先想清楚，我們的文件中需要哪些註釋，這是一件可以想清楚在做的事情
四、模板配置演示
首先我們要清楚需要配置哪些東西，我們拿 java 文件來舉例，起碼需要類註釋和方法註釋兩種常用的註釋，其要求如下
- 類註釋應該主要表述當前類服務於那個模塊，或者是哪些功能，它是何時創建，誰是它的作者
- 而方法的註釋應該包括創建時間、作者、參數、含義或功能等等
接下來我簡單的配置一下這兩種註釋
首先是類註釋：
選擇 Comments 中的 Types ，然後點擊 Edit ,
將如下內容替換掉原本的內容
/**
* @ClassName: ${type_name}
* @Description:${todo}(描述這個類的作用)
* @author: 你的名字
* @date: ${date} ${time}
* ${tags}
* @Copyright:
*/
然後點擊 Apply and Close ,到這裏我們對於類的註釋模板就配置完成了，接下來我們測試一下是否配置成功
首先創建一個類，在類中輸入 /** 然後點擊 enter 即可看見效果
至此，類的模板就配置成功，接下來就是配置其他類型的註釋，下面給大家一個參考
五、模板配置參考
- 文件(Files)註釋標籤：
/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: 描述
* @author: XXX
* @date: ${date} ${time}
* @Copyright:
*/
- 類型(Types)註釋標籤（類的註釋）：
/**
* @ClassName: ${type_name}
* @Description:${todo}(描述這個類的作用)
* @author: XXX
* @date: ${date} ${time}
* ${tags}
* @Copyright:
*/
- 字段(Fields)註釋標籤：
/**
* @Fields ${field} : ${todo}(這個變量表示什麼)
*/
- 構造函數標籤：
/**
* @Title: ${enclosing_type}
* @Description: ${todo}(描述這個方法的作用)
* @param: ${tags}
* @throws
*/
- 方法(Methods)標籤：
/**
* @Title: ${enclosing_method}
* @Description: ${todo}(描述這個方法的作用)
* @param: ${tags}
* @return: ${return_type}
* @throws
*/
- 覆蓋方法(Overriding Methods)標籤:
/**
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/
- 代表方法(Delegate Methods)標籤：
/**
* ${tags}
* ${see_to_target}
*/
- getter方法標籤：
/**
* @Title: ${enclosing_method} <BR>
* @Description: please write your description <BR>
* @return: ${field_type} <BR>
*/
- setter方法標籤：
/**
* @Title: ${enclosing_method} <BR>
* @Description: please write your description <BR>
* @return: ${field_type} <BR>
*/