Eclipse注释模板设置详解

设置注释模板的入口:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素。本文现就每一个元素逐一给大家介绍一下。

文件(Files)注释标签:

[html] view plain copy

/**  

* @Title: ${file_name}  

* @Package ${package_name}  

* @Description: ${todo}(用一句话描述该文件做什么)  

* @author ${user}  

* @date ${date}  

* @version V1.0  

*/  

类型(Types)注释标签(类的注释):

[html] view plain copy

/**  

* @ClassName: ${type_name}  

* @Description: ${todo}(这里用一句话描述这个类的作用)  

* @author ${user}  

* @date ${date}  

*  

* ${tags}  

*/  

字段(Fields)注释标签:

[html] view plain copy

/**  

* @Fields field:field:{todo}(用一句话描述这个变量表示什么)  

*/  


构造函数(Constructor)标签:

[html] view plain copy

/**  

* 创建一个新的实例 ${enclosing_type}.  

*  

* ${tags}  

*/  

方法(Methods)标签:

[html] view plain copy

/**  

* @Title: ${enclosing_method}  

* @Description: ${todo}(这里用一句话描述这个方法的作用)  

* @param ${tags}    参数  

* @return ${return_type}    返回类型  

* @throws  

*/  

覆盖方法(Overriding Methods)标签:

[html] view plain copy

/* (非 Javadoc)  

*

Title: ${enclosing_method}


*

Description: 


* ${tags}  

* ${see_to_overridden}  

*/  

代理方法(Delegate Methods)标签:

[html] view plain copy

/**  

* ${tags}  

* ${see_to_target}  

*/  

getter方法标签:

[html] view plain copy

/**  

* @return ${bare_field_name}  

*/  


setter方法标签:

[html] view plain copy

/**  

* @param paramtheparamthe{bare_field_name} to set  

*/  

要实现上面的注释模板,这需要将下面的配置文件导入就可以了:

[html] view plain copy



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

    * @version V1.0    

    */  


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

    * @date ${date}  

    *  

    * ${tags}  

    */  


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:field:{todo}(用一句话描述这个变量表示什么)  

    */  


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}.  

     *  

     * ${tags}  

     */  


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}    参数  

    * @return ${return_type}    返回类型  

    * @throws  

    */  


autoinsert="true"  

context="overridecomment_context"  

deleted="false"  

description="Comment for overriding methods"  

enabled="true"  

id="org.eclipse.jdt.ui.text.codetemplates.overridecomment"  

name="overridecomment">  

    /* (非 Javadoc)  

*

Title: ${enclosing_method}


*

Description: 


    * ${tags}  

    * ${see_to_overridden}  

    */  


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}  

     */  


autoinsert="false"  

context="gettercomment_context"  

deleted="false"  

description="Comment for getter method"  

enabled="true"  

id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"  

name="gettercomment">  

    /**  

    * @return ${bare_field_name}  

    */  


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 paramtheparamthe{bare_field_name} to set  

     */  

/* 确定一个系统的学习Java的计划,如果想自学,那么你就找一套非常系统的学习视频。如果你自己找不到系统的学习视频。可以加下小编的Java学习群:557865078,编号(烟火)不管你是小白还是大牛,小编我都欢迎,不定期分享干货,包括小编自己整理的一份2018最新的Java学习资料和0基础入门教程,欢迎初学和进阶中的小伙伴。*/

你可能感兴趣的:(Eclipse注释模板设置详解)