一寻拂、背景簡(jiǎn)介
豐富的注釋和良好的代碼規(guī)范晌坤，對(duì)于代碼的閱讀性和可維護(hù)性起著至關(guān)重要的作用逢艘。幾乎每個(gè)公司對(duì)這的要求還是比較嚴(yán)格的，往往會(huì)形成自己的一套編碼規(guī)范骤菠。但是再實(shí)施過程中它改，如果全靠手動(dòng)完成，不僅效率低下商乎，還難以保證真正的符合規(guī)范央拖。所以結(jié)合IDE環(huán)境，自動(dòng)生成注釋，還是很有必要的鲜戒。今天我們就說一下专控，如何使用Eclipse給我們提供的自定義代碼模版的功能來作業(yè)。
二遏餐、設(shè)置注釋模板
設(shè)置注釋模板的入口：Window->Preference->Java->Code Style->Code Template
然后展開Comments節(jié)點(diǎn)就是所有需設(shè)置注釋的元素了伦腐！
一下修改，只需要點(diǎn)擊右側(cè)面板上的按鈕 – 編輯(Edit)失都， 便可修改成自己的注釋柏蘑！
三、詳細(xì)介紹
1粹庞、文件(Files)注釋標(biāo)簽
Files標(biāo)簽是對(duì)新建的文件的說明咳焚，出現(xiàn)在文件最上面
- 推薦注釋風(fēng)格：
/**
* Copyright ? ${year} eSunny Info. Tech Ltd. All rights reserved.
*
* 功能描述：
* @Package: ${package_name}
* @author: ${user}
* @date: ${date} ${time}
*/
2、類型(Types)注釋標(biāo)簽（類的注釋）
Types標(biāo)簽是對(duì)類Class的一個(gè)說明庞溜，出現(xiàn)在類上面
- 推薦注釋風(fēng)格：
/**
* 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)注釋標(biāo)簽
Fields標(biāo)簽是對(duì)變量字段的說明
- 推薦注釋風(fēng)格：
// @Fields ${field} : ${todo}
4、構(gòu)造函數(shù)(Constructors)標(biāo)簽
Constructors標(biāo)簽是對(duì)類的構(gòu)造函數(shù)的說明
- 推薦注釋風(fēng)格：
/**
* @Function: ${file_name}
* @Description: 該函數(shù)的功能描述
*
* @param:參數(shù)描述
* @version: v1.0.0
* @author: ${user}
* @date: ${date} ${time}
*/
5流码、方法(Methods)標(biāo)簽
Methods標(biāo)簽是對(duì)函數(shù)方法的說明
- 推薦注釋風(fēng)格：
/**
* @Function: ${file_name}
* @Description: 該函數(shù)的功能描述
*
* @param:描述1描述
* @return：返回結(jié)果描述
* @throws：異常描述
*
* @version: v1.0.0
* @author: ${user}
* @date: ${date} ${time}
*
* Modification History:
* Date Author Version Description
*---------------------------------------------------------*
* ${date} ${user} v1.0.0 修改原因
*/
6又官、覆蓋方法(Overriding Methods)標(biāo)簽
Overriding Methods標(biāo)簽是對(duì)覆蓋方法的說明
- 推薦注釋風(fēng)格：
/**
* ${see_to_overridden}
* @Function: ${file_name}
* @Description: 該函數(shù)的功能描述
*
* @param:描述1描述
* @return：返回結(jié)果描述
* @throws：異常描述
*
* @version: v1.0.0
* @author: ${user}
* @date: ${date} ${time}
*
* Modification History:
* Date Author Version Description
*---------------------------------------------------------*
* ${date} ${user} v1.0.0 修改原因
*/
7、代表方法(Delegate Methods)標(biāo)簽
- 推薦注釋風(fēng)格：
/**
* ${tags}
* ${see_to_target}
*/
8旅掂、getter方法標(biāo)簽
- 推薦注釋風(fēng)格：
/**
* @return the ${bare_field_name}
*/
9赏胚、setter方法標(biāo)簽
- 推薦注釋風(fēng)格：
/**
* @param ${param} the ${bare_field_name} to set
*/
四访娶、如何自動(dòng)添加注釋
1商虐、可通過如下三種方法自動(dòng)添加注釋：
- 輸入“/**”并回車。
- 用快捷鍵 Alt＋Shift+J（先選中某個(gè)方法崖疤、類名或變量名）秘车。
- 在右鍵菜單中選擇“Source > Generate ElementComment”。
2劫哼、新建文件或類的時(shí)候叮趴，怎么自動(dòng)生成文件(file)的注釋呢？
只需要勾選Automatically and comments for new methods and types即可权烧！
3眯亦、導(dǎo)入/導(dǎo)出代碼格式模板
如果你辛辛苦苦定制好了自己的代碼風(fēng)格，然后換了臺(tái)機(jī)器進(jìn)行操作或重裝了Eclipse般码，是不是要重新配置一遍呢妻率？答案當(dāng)然是No了，Eclipse提供了“導(dǎo)出”和“導(dǎo)入”功能板祝，你可以把自己的模板導(dǎo)出來在其他機(jī)器上使用宫静。
五、創(chuàng)建自定義注釋模板
Window->Preference->Java->Editor->Templates
- eclipse自帶一些注釋模板，如日期(@date)孤里、文件名(@ClassName)囊榜、作者(@author)等漱病，那么怎么自定義一些注釋模板呢？
該文是在參考文中進(jìn)行一定修改而來
** 參考地址：http://blog.csdn.net/changqing5818/article/details/51996302**
