经过一段时间的摸索,对之前的Java文档注释模板的进行了修改,使其更符合我的喜好。下面是我导出的模板:codetemplates.xml,你也可以新建该文件,把下面的内容(模板代码)复制进去,然后把该文件导入到eclipse中。(如果不会导入,可参考下面注意的链接内容。)
注意:如果你害怕你不习惯我的模板或者不喜欢,你可以先按照【Java注释系列文章一】2、3点 把你的现有的模板导出,这样如果真的觉得该模板不符合你的喜好,你也可以恢复你原来的模板(即重新导入自己的)。
<?xml version="1.0" encoding="UTF-8" standalone="no"?><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">/**
* @Title ${enclosing_type}
* @Description ${todo}
* ${tags}
* @throws
*/
</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 ${user}
* @date ${d:date('yyyy-MM-dd HH:mm:ss')}
* @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">/**
* <p>Title: </p>
* <p>Description: </p>
* <p>Company: </p>
* @author ${user}
* @date ${d:date('yyyy-MM-dd HH:mm:ss')}
* @version v1.0
* ${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}
* @author ${user}
* @version v1.0
* @date ${d:date('yyyy-MM-dd HH:mm:ss')}
* @Description ${todo}
* ${tags}
* ${return_type}
* @see
* @exception
*/</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="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="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>
2019.6.25更新:
之前导出文件,发现xml文件格式好乱,于是就去格式化了一下;然后我把该文件导进去后,发现好像里面格式乱了……所以我决定还是把直接导出的文件贴上吧(虽然丑了点)。
2019.8.11更新:
生成文档是需要添加参数:
-encoding utf-8 -charset utf-8 -tag date:a:date -tag Title:a:Title -tag Description:a:Description -tag Fields:a:Fields
2019-9-29更新:
如需查看效果,可到我github的一个相关仓库:https://github.com/yansheng836/eclipse-codestyle 查看;同时这里还介绍了阿里巴巴P3C项目推荐的模板,我现在改用这个了,比较好用。
系列文章推荐阅读:
【Java文档注释系列文章一】如何在Eclipse中如何自动添加注释和自定义注释风格
【Java文档注释系列文章二】(My)Eclipse-自定义文档注释模板
【Java文档注释系列文章三】格式化代码不格式化注释,格式化代码注释不换行
【Java文档注释系列文章四】总结