编码规范（二）之Code Templates的设置（转）

http://swiftlet.net/archives/1199

编码规范（二）之Code Templates的设置（转）

文件(Files)注释标签：
/**
 * @Title: ${file_name}
 * @Package ${package_name}
 * @Description: ${todo}
 * Copyright: Copyright (c) 2011 
 * Company:成都康赛电子科大信息技术有限责任公司
 * 
 * @author Comsys-${user}
 * @date ${date} ${time}
 * @version V1.0
 */

类型(Types)注释标签（类的注释）：
/**
  * @ClassName: ${type_name}
  * @Description: ${todo}
  * @author Comsys-${user}
  * @date ${date} ${time}
  *
  * ${tags}
  */

字段(Fields)注释标签：
/**
  * @Fields ${field} : ${todo}（用一句话描述这个变量表示什么）
  */

构造函数标签：
/**

* 创建一个新的实例 ${enclosing_type}. 
  * <p>Title: </p>
  * <p>Description: </p>
  * ${tags}
  */

方法(Constructor & Methods)标签：
/**

* ${enclosing_method}(这里用一句话描述这个方法的作用)

* ${todo}(这里描述这个方法适用条件 – 可选)

* ${todo}(这里描述这个方法的执行流程 – 可选)

* ${todo}(这里描述这个方法的使用方法 – 可选)

* ${todo}(这里描述这个方法的注意事项 – 可选)

*
  * @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}
  */

从eclipse中导入以上设置:打开Window->Preferences->Java->Code Style->Code Templates

文件下载地址：/Files/jifeng/codetemplates.xml

<?xml version="1.0" encoding="UTF-8" standalone="no"?><templates><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">/**
 * getter method
 * @return the ${bare_field_name}
 */
</template><template autoinsert="false" context="settercomment_context" deleted="false" description="Comment for setter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/**
 * setter method
 * @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">/**

  * 创建一个新的实例 ${enclosing_type}. 
  * &lt;p&gt;Title: &lt;/p&gt;
  * &lt;p&gt;Description: &lt;/p&gt;
  * ${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) 2011 
 * Company:成都康赛电子科大信息技术有限责任公司
 * 
 * @author Comsys-${user}
 * @date ${date} ${time}
 * @version V1.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 Comsys-${user}
  * @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">/**
  * ${enclosing_method}(这里用一句话描述这个方法的作用)
  * ${todo}(这里描述这个方法适用条件 – 可选)
  * ${todo}(这里描述这个方法的执行流程 – 可选)
  * ${todo}(这里描述这个方法的使用方法 – 可选)
  * ${todo}(这里描述这个方法的注意事项 – 可选)
  *
  * @Title: ${enclosing_method}
  * @Description: ${todo}
  * @param ${tags}    设定文件
  * @return ${return_type}    返回类型
  * @throws
  */

</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">/*
  * &lt;p&gt;Title: ${enclosing_method}&lt;/p&gt;
  * &lt;p&gt;Description: &lt;/p&gt;
  * ${tags}
  * ${see_to_overridden}
  */

</template><template autoinsert="false" 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="true" context="newtype_context" deleted="false" description="Newly created files" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.newtype" name="newtype">${filecomment}
${package_declaration}

${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>