通过使用模版，将大部分生成方法自动添加注释，前期工作量比较大，但是在后期维护方面，就很自在的。
- <?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">
- /**
- * @Title ${enclosing_type}.
- * <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}
- * @author ZHANGJ
- * @date ${date}
- * @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 ZHANGJ
- * @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} 设定文件
- * @author ZHANGJ
- * @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">
- /**
- * <p>Title: ${enclosing_method}</p>
- * <p>Description: </p>
- * ${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>
创建xml文件，把上面代码段全部复制进去。然后挂到eclipse里面。 具体顺序是Window->Preference->Java->Code Style->Code Template，import导入刚才这个xml文件。 在apply的按钮上面有一个选择框，控制是否自动生成注释信息，那个选上，后期只要生成方法，注释信息就会自动添加 然后不管是英语还是汉语，或者什么暗号，就需要手动按照规格填写到注释里面。这样，在项目回溯的时候，就有了很大的一个参考和依据。
| 
收藏
淘帖
踩
