Eclipse自动生成注释

本人在学习工作中总结的注释模板：

<?xml version="1.0" encoding="UTF-8"?> <templates> <template autoinsert="true" context="gettercomment_context" deleted="false" description="Comment for getter method" 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="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> <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"> /** * <p>Title: </p> * <p>Description: </p> * ${tags} */ </template> <template autoinsert="false" context="filecomment_context" deleted="false" description="Comment for created Java files" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment"> /** * @Title: ${file_name} * @Package ${package_name} * @Description: ${todo}(用一句话描述该文件做什么) * Copyright: Copyright (c) 2009 * Company: pkpm * @author 代长亚 * @date ${date} ${time} *@version 1.0 */ </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"> /** * @ClassName: ${type_name} * @Description: ${todo}(这里用一句话描述这个类的作用) * @author 代长亚 * @date ${date} ${time} * ${tags} */ </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"> /** * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么) */ </template> <template autoinsert="false" context="methodcomment_context" deleted="false" description="Comment for non-overriding methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment"> /** * @Title: ${enclosing_method} * @Description:${todo}(这里用一句话描述这个方法的作用) * @param ${tags} 设定文件 * @return ${return_type} 返回类型 * @throws * @date ${date} ${time} */ </template> <template autoinsert="false" context="overridecomment_context" deleted="false" description="Comment for overriding methods" 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="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> <template autoinsert="false" context="newtype_context" deleted="false" description="Newly created files" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.newtype" name="newtype"> ${filecomment} ${package_declaration} /** * @Title: ${file_name} * @Package ${package_name} * @Description: ${todo}(添加描述) * @author 代长亚 * @date ${date} ${time} * @version V1.0 */ ${typecomment} ${type_declaration} </template> <template autoinsert="true" context="classbody_context" deleted="false" description="Code in new class type bodies" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.classbody" name="classbody"> </template> <template autoinsert="true" context="interfacebody_context" deleted="false" description="Code in new interface type bodies" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.interfacebody" name="interfacebody"> </template> <template autoinsert="true" context="enumbody_context" deleted="false" description="Code in new enum type bodies" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.enumbody" name="enumbody"> </template> <template autoinsert="true" context="annotationbody_context" deleted="false" description="Code in new annotation type bodies" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.annotationbody" name="annotationbody"> </template> <template autoinsert="true" context="catchblock_context" deleted="false" description="Code in new catch blocks" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.catchblock" name="catchblock"> // ${todo} Auto-generated catch block ${exception_var}.printStackTrace(); </template> <template autoinsert="true" context="methodbody_context" deleted="false" description="Code in created method stubs" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodbody" name="methodbody"> // ${todo} Auto-generated method stub ${body_statement} </template> <template autoinsert="true" context="constructorbody_context" deleted="false" description="Code in created constructor stubs" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorbody" name="constructorbody"> ${body_statement} // ${todo} Auto-generated constructor stub </template> <template autoinsert="true" context="getterbody_context" deleted="false" description="Code in created getters" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.getterbody" name="getterbody"> return ${field}; </template> <template autoinsert="true" context="setterbody_context" deleted="false" description="Code in created setters" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.setterbody" name="setterbody"> ${field} = ${param}; </template> </templates>

有模板生成的代码注释：

/** * @Title: test.java * @Package temp * @Description: TODO(用一句话描述该文件做什么) * Copyright: Copyright (c) 2009 * Company: pkpm * @author 代长亚 * @date 2010-1-4 下午04:06:46 * @version 1.0 */ package temp; /** * @ClassName: test * @Description: TODO(这里用一句话描述这个类的作用) * @author 代长亚 * @date 2010-1-4 下午04:06:46 * */ public class test { /** * @Fields name : TODO(用一句话描述这个变量表示什么) */ public String name; /** * <p>Title: </p> * <p>Description: </p> */ public test() { // TODO Auto-generated constructor stub } /** * @Title: main * @Description: TODO(这里用一句话描述这个方法的作用) * @param args 设定文件 * @return void 返回类型 * @throws * @date 2010-1-4 下午04:49:08 */ public static void main(String[] args) { // TODO Auto-generated method stub String sql = null; System.out.println(sql); } }