JAVA开发经验（一）:Eclipse使用1.1-注释模板（code templates）配置详解及自动添加注释

摘要说明：

本篇文章主要讲述如何配置eclipse的java代码注释及注释相关详解；同时讲述如何设置自动添加注释：

1.添加方式

配置路径为：Window-->Preferences-->Java-->Code Style-->Code Templates;如下图

手动配置：手动点击每个注释类型，收订修改即可；

模板修改：使用import导入模板文件即可，文件内容如下，文件名可自取如code_templates.xml；

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<templates>
<template autoinsert="true" context="filecomment_context" deleted="false" 
description="文件(java)注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" 
name="filecomment">
/**
 * @模块名：${project_name}
 * @包名：${package_name}
 * @描述：${file_name}
 * @版本：1.0
 * @创建人：${user}
 * @创建时间：${date}${time}
 */
</template>

<template autoinsert="false" context="typecomment_context" deleted="false" 
description="类(java)注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" 
name="typecomment">
/**
 * @模块名：${project_name}
 * @包名：${package_name}
 * @类名称： ${type_name}
 * @类描述：【类描述】
 * @版本：1.0
 * @创建人：${user}
 * @创建时间：${date}${time}
 * ${tags}
 */
</template>

<template autoinsert="true" context="fieldcomment_context" deleted="false" 
description="类字段注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" 
name="fieldcomment">
/**
 *
 */
</template>

<template autoinsert="true" context="constructorcomment_context" deleted="false" 
description="构造方法注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"
name="constructorcomment">
/**
 * ${tags}
 */
</template>

<template autoinsert="true" context="methodcomment_context" deleted="false" 
description="方法体注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" 
name="methodcomment">
/**
 * @方法名：${enclosing_method}
 * @方法描述【方法功能描述】
 * ${tags}
 * @修改描述【修改描述】
 * @版本：1.0
 * @创建人：${user}
 * @创建时间：${date} ${time}
 * @修改人：${user}
 * @修改时间：${date} ${time}
 */
</template>

<template autoinsert="true" context="overridecomment_context" deleted="false" 
description="重写方法注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" 
name="overridecomment">
/**
 * (non-Javadoc)
 * ${see_to_overridden}
 * ${tags}
 */
</template>

<template autoinsert="true" context="delegatecomment_context" deleted="false" 
description="代理方法注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" 
name="delegatecomment">
/**
 * ${tags}
 * ${see_to_target}
 */
</template>

<template autoinsert="true" context="gettercomment_context" deleted="false" 
description="get方法注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" 
name="gettercomment">
/**
 * @return the ${bare_field_name}
 */
</template>

<template autoinsert="true" context="settercomment_context" deleted="false" 
description="set方法注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" 
name="settercomment">
/**
 * @param ${param} the ${bare_field_name} to set
 */
</template>

<template autoinsert="false" context="newtype_context" deleted="false" 
description="类模板" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.newtype" 
name="newtype"> 
</template>

<template autoinsert="true" context="classbody_context" deleted="false" 
description="类体模板" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.classbody" 
name="classbody">
</template>

<template autoinsert="true" context="interfacebody_context" deleted="false" 
description="接口模板" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.interfacebody" 
name="interfacebody">
</template>
<template autoinsert="true" context="enumbody_context" deleted="false" 
description="枚举模板" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.enumbody" 
name="enumbody">
</template>

<template autoinsert="true" context="annotationbody_context" deleted="false" 
description="注释模板" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.annotationbody" 
name="annotationbody">
</template>

<template autoinsert="false" context="methodbody_context" deleted="false" 
description="方法体模板" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodbody" 
name="methodbody">
</template>

<template autoinsert="true" context="constructorbody_context" deleted="false" 
description="构造函数模板" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorbody" 
name="constructorbody">
</template>

<template autoinsert="true" context="getterbody_context" deleted="false" 
description="get方法模板" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.getterbody" 
name="getterbody">
</template>

<template autoinsert="true" context="setterbody_context" deleted="false" 
description="set方法模板" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.setterbody" 
name="setterbody">
</template>

<template autoinsert="true" context="catchblock_context" deleted="false" 
description="异常catch代码模板" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.catchblock" 
name="catchblock">
</template>
</templates>

2.配置详解

Code Templates下有两类，一类Comments表示注释；一类Code表示为代码模板

Comments(注释模板)：

Files(文件注释):filecomment_context
Types(文件注释):typecomment_context
Fields(类字段注释):fieldcomment_context
Constructors(构造方法注释):constructorcomment_context
Methods(方法体注释):methodcomment_context
Overriding methods(重写方法注释):overridecomment_context
Delegate methods(代理方法注释):delegatecomment_context
Getters(get方法注释):gettercomment_context
Setters(set方法注释):settercomment_context

Code(代码模板)：

New Java files(类模板):newtype_context
Class body(类体模板):classbody_context
Interface body(接口模板):interfacebody_context
Enum body(枚举模板):enumbody_context
Annotation body(注释模板):annotationbody_context
Method body(方法体模板):methodbody_context
constructor body(构造函数模板):constructorbody_context
Getter body(get方法模板):getterbody_context
Setter body(set方法模板):setterbody_context
Catch block body(异常catch代码模板):catchblock_context

注释模板中的常用动态参数说明如下：

${project_name}：项目名
${package_name}：包名
${file_name}：文件名
${type_name}：类名
${user}：当前用户
${date}：当前日期
${time}：当前时间
${enclosing_method}：方法名
${tags}：入参及返回参数

3.设置自动添加注释

在Window-->Preferences-->Java-->Code Style-->Code Templates下勾选Automatically add Comments for new Methods and types；在点Apply保存配置即可；