Eclipse Java代码注释模板的设置

俗话说，工欲善其事，必先利其器。

eclipse作为一种非常重要的IDE，也是非常重要的。日程工作中，我们可以使用对其进行改造，让它更方便，提高我们工作的效率。Java模板注释就是很重要的。

1. eclipse用户名的设置：

在eclipse的安装路径下，打开eclipse.ini的配置文件：

-startupplugins/org.eclipse.equinox.launcher_1.2.0.v20110502.jar--launcher.libraryplugins/org.eclipse.equinox.launcher.win32.win32.x86_1.1.100.v20110502-productorg.eclipse.epp.package.java.product--launcher.defaultActionopenFile--launcher.XXMaxPermSize256M-showsplashorg.eclipse.platform--launcher.XXMaxPermSize256m--launcher.defaultActionopenFile-vmargs-Duser.name=xxx-Dosgi.requiredJavaVersion=1.5-Xms40m-Xmx384m

在-vmargs下加入：

-Duser.name=你的名字

2. 注释模板的设置

我们打开

Window->Preference->Java->Code Style->Code Template 

然后展开Comments节点就是所有需设置注释的元素啦。

2.1 注释格式以及各个主要简介

1. 单行(single-line)注释：“//……”
2. 块(block)注释：“/*……*/”
3. 文档注释：“/**……*/”
4. javadoc注释标签语法

@author   对类的说明标明开发该类模块的作者
@version   对类的说明标明该类模块的版本
@see    对类、属性、方法的说明参考转向，也就是相关主题
@param    对方法的说明对方法中某参数的说明
@return   对方法的说明对方法返回值的说明
@exception  对方法的说明对方法可能抛出的异常进行说明

@return_type返回类型

@date 日期

@time时间

2.2 注释元素说明

• 文件(Files)注释标签：

/**   
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}(用一句话描述该文件做什么)
* @author A18ccms A18ccms_gmail_com   
* @date ${date} ${time}
* @version V1.0   
*/

• 类型(Types)注释标签（类的注释）：

/**
* @ClassName: ${type_name}
* @Description: ${todo}(这里用一句话描述这个类的作用)
* @author A18ccms a18ccms_gmail_com
* @date ${date} ${time}
* 
* ${tags}
*/

• 字段(Fields)注释标签：

/**
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
*/

• 构造函数标签：

/**
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/

• 方法(Constructor & Methods)标签：

/**
* @Title: ${enclosing_method}
* @Description: ${todo}(这里用一句话描述这个方法的作用)
* @param ${tags}    设定文件
* @return ${return_type}    返回类型
* @throws
*/

• 覆盖方法(Overriding Methods)标签：

/* (非 Javadoc)
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/

• 代表方法(Delegate Methods)标签：

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

• getter方法标签：

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

• setter方法标签：

/**
* @param ${param} 要设置的 ${bare_field_name}
*/

3. 几个注释模板

模板1：

<?xml version="1.0" encoding="UTF-8"?><templates><template autoinsert="true" context="fieldcomment_context" deleted="false" description="字段的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/*** @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)*/</template><template autoinsert="true" context="gettercomment_context" deleted="false" description="getter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/** * @return ${bare_field_name} */</template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="创建的构造函数的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/*** <p>Title:${file_name} </p>* <p>Description: 构造函数</p>* ${tags}*/</template><template autoinsert="true" context="filecomment_context" deleted="false" description="已创建的 Java 文件的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/**  * @Title: ${file_name}* @Package ${package_name}* @Description: ${todo}(用一句话描述该文件做什么)* @author long.luo* @date ${date} ${time}* @version V1.0  */ </template> <template autoinsert="true" context="settercomment_context" deleted="false" description="setter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/** * @param ${param} 要设置的 ${bare_field_name} */  </template> <template autoinsert="true" context="typecomment_context" deleted="false" description="创建的类型的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/** * @author ${user} * * ${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="overridecomment_context" deleted="false" description="覆盖方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">/** (非 Javadoc)* <p>Title: ${enclosing_method}</p>* <p>Description: </p>* ${tags}* ${see_to_overridden}*/</template><template autoinsert="true" context="methodcomment_context" deleted="false" description="非覆盖方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/** * ${tags} */ </template></templates>

模板2：

<?xml version="1.0" encoding="UTF-8"?><templates><template autoinsert="false"   context="constructorcomment_context" deleted="false" description="Comment for created constructors" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"name="constructorcomment">/** * 创建一个新的实例 ${enclosing_type}. * * ${tags} */</template><template autoinsert="true" context="settercomment_context"deleted="false" description="Comment for setter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/** * @param ${param} the ${bare_field_name} to set */</template><templateautoinsert="false" context="methodcomment_context" deleted="false" description="Comment for non-overriding methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/** * 此方法描述的是： * @author: [e-mail] * @version: ${date} ${time} */</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="Comment for delegate methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/** * ${tags} * ${see_to_target} */</template><templateautoinsert="false" context="filecomment_context" deleted="false" description="Comment for created Java files" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/** * 文件名：${file_name} * * 版本信息： * 日期：${date} * Copyright 足下 Corporation ${year}  * 版权所有 * */</template><template autoinsert="false" context="gettercomment_context" deleted="false" description="Comment for getter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/** * ${bare_field_name} * * @return  the ${bare_field_name} * @since   CodingExample Ver(编码范例查看) 1.0*/</template><template autoinsert="true" context="overridecomment_context" deleted="false" description="Comment for overriding methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">/* (non-Javadoc) * ${see_to_overridden} */</template><template autoinsert="false" context="fieldcomment_context" deleted="false" description="Comment for fields" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/** * ${field}:${todo}（用一句话描述这个变量表示什么） * * @since Ver 1.1 */</template><template autoinsert="false" context="typecomment_context" deleted="false" description="Comment for created types" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/** * 此类描述的是： * @author: [e-mail] * @version: ${date} ${time}  */</template>  </templates>

以上请知悉！