`

Eclipse 代码注释模板

    博客分类:
  • JAVA
阅读更多
设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍:
文件(Files)注释标签:

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

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

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

字段(Fields)注释标签:

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

/**
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/

方法(Constructor & 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} 要设置的 ${bare_field_name}
*/
例子:
<?xml version="1.0" encoding="UTF-8"?>
<templates>
    <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="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="methodcomment_context"   
                deleted="false"   
                description="Comment for non-overriding methods"   
                enabled="true"   
                id="org.eclipse.jdt.ui.text.codetemplates.methodcomment"   
                name="methodcomment">
    /**  
     * 此方法描述的是:  
     * @author: wangxiongdx@163.com  
     * @version: ${date} ${time}  
     */  
    </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="filecomment_context"   
                deleted="false"   
                description="Comment for created Java files"   
                enabled="true"   
                id="org.eclipse.jdt.ui.text.codetemplates.filecomment"   
                name="filecomment">
    /**  
     * 文件名:${file_name}  
     *  
     * 版本信息:  
     * 日期:${date}  
     * Copyright 足下 Corporation ${year}   
     * 版权所有  
     *  
     */  
    </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">
    /**  
     * ${bare_field_name}  
     *  
     * @return the ${bare_field_name}  
     * @since   CodingExample Ver(编码范例查看) 1.0  
    */  
    </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">
    /* (non-Javadoc)  
     * ${see_to_overridden}  
     */  
    </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 Ver 1.1  
     */  
    </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">
    /**  
     * 此类描述的是:  
     * @author: wangxiongdx@163.com  
     * @version: ${date} ${time}   
     */  
    </template>
</templates>
<?xml version="1.0" encoding="UTF-8"?>
<templates>
    <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="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="methodcomment_context"
                deleted="false"
                description="Comment for non-overriding methods"
                enabled="true"
                id="org.eclipse.jdt.ui.text.codetemplates.methodcomment"
                name="methodcomment">
    /**
     * 此方法描述的是:
     * @author: wangxiongdx@163.com
     * @version: ${date} ${time}
     */
    </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="filecomment_context"
                deleted="false"
                description="Comment for created Java files"
                enabled="true"
                id="org.eclipse.jdt.ui.text.codetemplates.filecomment"
                name="filecomment">
    /**
     * 文件名:${file_name}
     *
     * 版本信息:
     * 日期:${date}
     * Copyright 足下 Corporation ${year}
     * 版权所有
     *
     */
    </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">
    /**
     * ${bare_field_name}
     *
     * @return the ${bare_field_name}
     * @since   CodingExample Ver(编码范例查看) 1.0
    */
    </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">
    /* (non-Javadoc)
     * ${see_to_overridden}
     */
    </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 Ver 1.1
     */
    </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">
    /**
     * 此类描述的是:
     * @author: wangxiongdx@163.com
     * @version: ${date} ${time}
     */
    </template>
</templates>
分享到:
评论

相关推荐

    Eclipse代码注释模板——code templates

    **Eclipse代码注释模板** Eclipse的代码注释模板允许用户自定义不同类型的注释模板,如类、方法、变量等。这些模板可以在编写代码时自动插入,减少手动输入的时间。模板支持包括但不限于以下类型: 1. 类注释...

    Eclipse代码注释模板

    Eclipse代码注释模板,可以用于myeclipse等开发IDE,注释包括Class,method等

    eclipse代码注释模板

    eclipse代码注释模板 。

    eclipse 代码注释模板(很实用)

    eclipse 代码注释模板(很实用)

    eclipse 代码 注释模板xml

    将代码注释以xml形式,直接导入eclipse。免去了繁琐的一步步的配置

    eclipse注释模板

    代码格式化和代码注释规范,导入eclipse中,一般在类和方法上都必须加通用文档注释,说明类和方法的作用,在特殊字段加相应注释,在复杂代码逻辑加相应行内注释说明代码逻辑。

    Eclipse Java 注释模板

    Eclipse作为一款强大的Java集成开发环境(IDE),提供了许多便捷的功能,其中之一就是“Eclipse Java 注释模板”。通过配置和使用这些模板,程序员可以快速地为代码添加注释,提高代码的可读性和维护性。下面我们将...

    Eclipse注释模板和格式化模板.zip

    在Eclipse中,注释模板和格式化模板是两个非常实用的功能,可以帮助开发者快速编写规范、一致的代码。本资料包“Eclipse注释模板和格式化模板.zip”包含了配置这两个功能所需的文件。 首先,我们来看看`code...

    Eclipse Java注释模板.txt

    Eclipse作为一款非常受欢迎的Java集成开发环境(IDE),提供了强大的功能来支持用户自定义代码注释模板,这有助于保持代码的一致性和可读性。 #### 二、Eclipse Java注释模板配置方法 要在Eclipse中设置Java注释...

    Eclipse注释模板自定义

    总结,Eclipse的注释模板自定义功能允许开发者根据个人或团队的需求创建个性化的注释格式,提高代码的可读性和规范性。同时,通过`eclipse.ini`配置文件,可以全局管理版权信息,确保团队代码的统一性和合法性。熟练...

    eclipse代码模板codetemplates.xml

    eclipse 标准 codetemplates.xml 代码模板,标准、简洁、好用

    java注释模板(xml) eclipse

    eclipse 注释模板 Window-&gt;Preference-&gt;Java-&gt;Code Style-&gt;Code Template -&gt;import你下载的文件

    Eclipse 注释导入模板

    Eclipse注释模板。 Eclipse代码注释模板, 用来注释方法和类时使用, 常用JAVA注释模板, 快捷方便, 简单易用。

    Eclipse注释模板变量补丁

    Eclipse的代码注释模板很丰富,如:user、year、date、time等等,通过在eclipse.ini文件中-Duser.name=xxxx进行配置,但是Eclipse的Preferences界面至今都不支持定制自己的注释模板变量,要新增一个注释变量的话,就...

    eclipse中注释模板和代码格式化模板

    超使用的eclipse中注释模板和代码格式化模板 ,

Global site tag (gtag.js) - Google Analytics