豐富eclipse注解的內容

2019-11-14 15:35:00

字體：大中小

來源：轉載

供稿：網友

如何豐富eclipse注解的內容

eclipse -> Window -> PReferences -> Code Templates -> Comments (Comments代表注釋模板)

1、 Files（java文件注釋）

/** * Project Name:${project_name} * File Name:${file_name} * Package Name:${package_name} * Date:${date}${time} * Copyright (c) ${year}, chenzhou1025@126.com All Rights Reserved. */

2、Types（Java類注釋）

/** * ClassName: ${type_name} <br/> * Function: ${todo} ADD FUNCTION. <br/> * Reason: ${todo} ADD REASON(可選). <br/> * date: ${date} ${time} <br/> * @author ${user} * @version ${enclosing_type}${tags} * @since JDK 1.6 */

3、Fields（類字段注釋）

/** * ${field}:${todo}(用一句話描述這個變量表示什么). * @since JDK 1.6 */

4、Constructors（構造函數注釋）

/** * Creates a new instance of ${enclosing_type}. * ${tags} */

5、Methods（Java方法注釋）

/** * ${enclosing_method}:(這里用一句話描述這個方法的作用). <br/> * ${todo}(這里描述這個方法適用條件 – 可選).<br/> * ${todo}(這里描述這個方法的執行流程 – 可選).<br/> * ${todo}(這里描述這個方法的使用方法 – 可選).<br/> * ${todo}(這里描述這個方法的注意事項 – 可選).<br/> * @author ${user} * ${tags} * @since JDK 1.6 */

6、Overriding methods（重寫方法注釋）

/** * ${todo} 簡單描述該方法的實現功能（可選）. * ${see_to_overridden} */

7、Delegate methods（代理方法注釋）

/** * ${tags} * ${see_to_target} */

8、Getters（Java Getter方法注釋）

/** * ${bare_field_name}. * @return  the ${bare_field_name} * @since   JDK 1.6 */

9、Setters（Java Setters方法注釋）

/** * ${param}. * @param   ${param}    the ${bare_field_name} to set * @since   JDK 1.6 */

eclipse -> Window -> Preferences -> Code Templates -> Code (Code代表代碼模板)

1、New Java files（新建java文件代碼模板）

/** * Project Name:${project_name} * File Name:${file_name} * Package Name:${package_name} * Date:${date}${time} * Copyright (c) ${year}, chenzhou1025@126.com All Rights Reserved. **/${filecomment}${package_declaration}/** * ClassName:${type_name} <br/> * Function: ${todo} ADD FUNCTION. <br/> * Reason:     ${todo} ADD REASON. <br/> * Date:     ${date} ${time} <br/> * @author   ${user} * @version   * @since    JDK 1.6 * @see       */${typecomment}${type_declaration}

2、Method body（方法體模板）

// ${todo} Auto-generated method stub${body_statement}

3、Constructor body（構造函數模板）

${body_statement}// ${todo} Auto-generated constructor stub

4、Getter body（字段Getter方法模板

return ${field};

5、Setter body（字段Setter方法模板）

${field} = ${param};

6、Catch block body（異常catch代碼塊模板）

// ${todo} Auto-generated catch block${exception_var}.printStackTrace();

詳細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">/** * ${bare_field_name}. * * @return  the ${bare_field_name} * @since   JDK 1.6 */</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">/** * ${param}. * * @param   ${param}    the ${bare_field_name} to set * @since   JDK 1.6 */</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">/** * Creates a new instance of ${enclosing_type}. * * ${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">/** * Project Name:${project_name} * File Name:${file_name} * Package Name:${package_name} * Date:${date}${time} * Copyright (c) ${year}, chenzhou1025@126.com All Rights Reserved. * */</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} &lt;br/&gt; * Function: ${todo} ADD FUNCTION. &lt;br/&gt; * Reason: ${todo} ADD REASON(可選). &lt;br/&gt; * date: ${date} ${time} &lt;br/&gt; * * @author ${user} * @version ${enclosing_type}${tags} * @since JDK 1.6 */</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">/** * ${field}:${todo}(用一句話描述這個變量表示什么). * @since JDK 1.6 */</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}:(這里用一句話描述這個方法的作用). &lt;br/&gt; * ${todo}(這里描述這個方法適用條件 – 可選).&lt;br/&gt; * ${todo}(這里描述這個方法的執行流程 – 可選).&lt;br/&gt; * ${todo}(這里描述這個方法的使用方法 – 可選).&lt;br/&gt; * ${todo}(這里描述這個方法的注意事項 – 可選).&lt;br/&gt; * * @author ${user} * ${tags} * @since JDK 1.6 */</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">/** * ${todo} 簡單描述該方法的實現功能（可選）. * ${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">/** * Project Name:${project_name} * File Name:${file_name} * Package Name:${package_name} * Date:${date}${time} * Copyright (c) ${year}, chenzhou1025@126.com All Rights Reserved. **/${filecomment}${package_declaration}/** * ClassName:${type_name} &lt;br/&gt; * Function: ${todo} ADD FUNCTION. &lt;br/&gt; * Reason:     ${todo} ADD REASON. &lt;br/&gt; * Date:     ${date} ${time} &lt;br/&gt; * @author   ${user} * @version   * @since    JDK 1.6 * @see       */${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="false" 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>