/** * ******************************************************** * ---功能描述: 查询用户信息用于发送邮件 ********************************************************** * ---@param userEntity * ---@throws Exception ********************************************************** * ---@author 名字 [zt_zoro1272@163.com ] ********************************************************** * ---@since 2014-8-19 ********************************************************** * ---@update:[变更日期YYYY-MM-DD][更改人姓名][变更描述] ********************************************************** * */
上面是效果
1.codetemplates.xml
1 <?xml version="1.0" encoding="UTF-8"?><templates><template autoinsert="true" context="methodcomment_context" deleted="false" description="非覆盖方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/********************************************************** 2 * ---功能描述: 3 ********************************************************** 4 * ---${tags} 5 ********************************************************** 6 * ---@author 自己的名字 [自己的邮箱 ] 7 ********************************************************** 8 * ---@since ${date} 9 ********************************************************** 10 * ---@update:[变更日期YYYY-MM-DD][更改人姓名][变更描述] 11 ********************************************************** 12 **/</template><template autoinsert="true" context="typecomment_context" deleted="false" description="创建的类型的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/********************************************************** 13 ********************************************************** 14 * ---@author 自己的名字[自己的邮箱 ] 15 ********************************************************** 16 * ---@version 17 ********************************************************** 18 * ---@since ${date} 19 */</template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="Comment for created constructors" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/ ********************************************************** 20 * ---${tags} 21 ********************************************************** 22 */</template><template autoinsert="true" context="gettercomment_context" deleted="false" description="getter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/** 23 * ---@return 返回 ${bare_field_name}。 24 */</template><template autoinsert="false" context="overridecomment_context" deleted="false" description="覆盖方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">/* 25 * ---(non-Javadoc) 26 * --- 27 * ---${see_to_overridden} 28 */</template><template autoinsert="true" context="filecomment_context" deleted="false" description="Comment for created Java files" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/* 29 * ---文件名: ${file_name} 30 ********************************************************** 31 * ---创建日期: ${date} 32 ********************************************************** 33 * ---Copyright(C) ${year}, by zhouTao. 34 ********************************************************** 35 * ---作者: 自己的名字[自己的邮箱 ] 36 ********************************************************** 37 */</template><template autoinsert="true" context="settercomment_context" deleted="false" description="setter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/** 38 * ---@param ${param} 要设置的 ${bare_field_name}。 39 */</template><template autoinsert="false" context="fieldcomment_context" deleted="false" description="字段的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/** 40 * ---${field} 41 */</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="代表方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/** 42 * ---功能描述: 43 ********************************************************** 44 * ---${tags} 45 ********************************************************** 46 * ---@author 自己的名字[自己的邮箱] 47 ********************************************************** 48 * ---@since ${date} 49 ********************************************************** 50 * ---${see_to_target} 51 ********************************************************** 52 * ---@update:[变更日期YYYY-MM-DD][更改人姓名][变更描述] 53 */</template><template autoinsert="false" context="constructorcomment_context" deleted="false" description="创建的构造函数的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/** 54 * ---功能描述: 55 ********************************************************** 56 * ---@constructor 方法 57 */</template></templates>
2.format.xml
<?xml version="1.0" encoding="UTF-8" standalone="no"?><templates><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="setterbody_context" deleted="false" description="Code in created setters" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.setterbody" name="setterbody">${field} = ${param};</template><template autoinsert="true" context="setterbody_context" deleted="false" description="Code in created setters" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.setterbody" name="setterbody">${field} = ${param};</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="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="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="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="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="getterbody_context" deleted="false" description="Code in created getters" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.getterbody" name="getterbody">return ${field};</template><template autoinsert="true" context="newtype_context" deleted="false" description="Newly created files" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.newtype" name="newtype">${filecomment} ${package_declaration} ${typecomment} ${type_declaration}</template><template autoinsert="true" context="catchblock_context" deleted="false" description="Code in new catch blocks" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.catchblock" name="catchblock">// ${todo} Auto-generated catch block ${exception_var}.printStackTrace();</template><template autoinsert="true" context="constructorbody_context" deleted="false" description="Code in created constructor stubs" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.constructorbody" name="constructorbody">${body_statement} // ${todo} Auto-generated constructor stub</template><template autoinsert="true" context="methodbody_context" deleted="false" description="Code in created function stubs" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.methodbody" name="methodbody">// ${todo} Auto-generated function stub ${body_statement}</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="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="classbody_context" deleted="false" description="Code in new class type bodies" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.classbody" name="classbody"> </template></templates>
使用方法:
一、修改codetemplates.xml
1.找到ID为org.eclipse.jdt.ui.text.codetemplates.typecomment的<template>元素,对元素体中注释的内容进行修改
@author属性中的"mailto:matrix_neyo@126.com"为作者邮箱,应改为大家自己的邮箱。后面的"neo"为作者的改名,应改为自己的改名(可以为中文,neo为本人的English name)
2.找到ID为org.eclipse.jdt.ui.text.codetemplates.filecomment的<template>元素,对元素体中注释的内容进行修改
"Copyright(C) ${year}, by neo."中包含了作者的改名,将"neo"改为自己的改名。"原始作者....."中的修改方法与改动1相同。
二、导入代码注释和格式化文本
窗口(Window)-->首先项(Properties...)-->Java(Java)-->代码样式(Code Style)-->代码模板(Code Templates)
点击一下右侧的"注释(Comments)",再点击"导入(Import...)",将"codetemplates.xml"导入
点击一下右侧的"代码(Code)",再点击"导入(Import...)",将"format.xml"导入
导入成功后,展开"注释(Comments)",点击"文件(Files)"会看到注释的效果