Eclipse Java注释模板设置详解以及版权声明

来源:互联网 发布:mirrorlink已认证软件 编辑:程序博客网 时间:2021/01/24 08:05

http://www.cnblogs.com/lr393993507/p/5867623.html

http://blog.csdn.net/security08/article/details/5588013

http://www.mamicode.com/info-detail-1189897.html

网上的Eclipse注释模板,在这里稍稍整理一些比较常用的。

编辑注释模板的方法:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍:

1.文件(Files)注释标签:

复制代码
/**   * All rights Reserved, Designed By www.tydic.com * @Title:  ${file_name}    * @Package ${package_name}    * @Description:    ${todo}(用一句话描述该文件做什么)    * @author: 天源迪科技      * @date:   ${date} ${time}    * @version V1.0  * @Copyright: ${year} www.tydic.com Inc. All rights reserved.  * 注意:本内容仅限于深圳天源迪科信息技术股份有限公司内部传阅,禁止外泄以及用于其他的商业目 */  
复制代码

 

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

复制代码
/**    * @ClassName:  ${type_name}    * @Description:${todo}(这里用一句话描述这个类的作用)    * @author: 天源迪科  * @date:   ${date} ${time}    *    * ${tags}   * @Copyright: ${year} www.tydic.com Inc. All rights reserved.  * 注意:本内容仅限于深圳天源迪科信息技术股份有限公司内部传阅,禁止外泄以及用于其他的商业目  */  
复制代码

3.字段(Fields)注释标签:

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

4.构造函数标签:

复制代码
/**    * @Title:  ${enclosing_type}    * @Description:    ${todo}(这里用一句话描述这个方法的作用)    * @param:  ${tags}   * @throws    */  
复制代码

5.方法(Methods)标签:

复制代码
/**    * @Title: ${enclosing_method}    * @Description: ${todo}(这里用一句话描述这个方法的作用)    * @param: ${tags}       * @return: ${return_type}       * @throws    */  
复制代码

6.覆盖方法(Overriding Methods)标签:

复制代码
/**    * <p>Title: ${enclosing_method}</p>    * <p>Description: </p>    * ${tags}    * ${see_to_overridden}    */  
复制代码

7.代表方法(Delegate Methods)标签:

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

8.getter方法标签:

/**   * @Title:  ${enclosing_method} <BR>   * @Description: please write your description <BR>   * @return: ${field_type} <BR>   */  

9.setter方法标签:

/**   * @Title:  ${enclosing_method} <BR>   * @Description: please write your description <BR>   * @return: ${field_type} <BR>   */  

剩下的就默认了,^_^



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

 

文件(Files)注释标签:

/*** @Title: ${file_name}* @Package ${package_name}* @Description: ${todo}(用一句话描述该文件做什么)* @author ${user}* @date ${date}* @version V1.0*/

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

/*** @ClassName: ${type_name}* @Description: ${todo}(这里用一句话描述这个类的作用)* @author ${user}* @date ${date}** ${tags}*/

字段(Fields)注释标签:

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

构造函数(Constructor)标签:

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

方法(Methods)标签:

/*** @Title: ${enclosing_method}* @Description: ${todo}(这里用一句话描述这个方法的作用)* @param ${tags}    参数* @return ${return_type}    返回类型* @throws*/

覆盖方法(Overriding Methods)标签:

/* (非 Javadoc)* <p>Title: ${enclosing_method}</p>* <p>Description: </p>* ${tags}* ${see_to_overridden}*/

代理方法(Delegate Methods)标签:

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

getter方法标签:

/*** @return ${bare_field_name}*/

setter方法标签:

/*** @param ${param} the ${bare_field_name} to set*/

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

<?xml version="1.0" encoding="UTF-8"?><templates>    <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 ${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 ${user}    * @date ${date}    *    * ${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="constructorcomment_context"                deleted="false"                description="Comment for created constructors"                enabled="true"                id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"                name="constructorcomment">    /**     * 创建一个新的实例 ${enclosing_type}.     *     * ${tags}     */    </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}    参数    * @return ${return_type}    返回类型    * @throws    */    </template>    <template                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)    * <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="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}    */    </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> </templates>

 


阅读全文
0 0
原创粉丝点击