`

Eclipse Java注释模板设置详解 - 引用

阅读更多

引用说明:原文来自于 http://blog.csdn.net/ahhsxy/archive/2009/09/11/4542682.aspx ,为了方便本人阅读,文本格式略有调整。

 

设置注释模板的入口: 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="true" context="fieldcomment_context" deleted="false" description="字段的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/**
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
*/
</template><template autoinsert="true" context="gettercomment_context" deleted="false" description="getter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/**
* @return ${bare_field_name}
*/
</template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="创建的构造函数的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/**
* <p>Title:${file_name} </p>
* <p>Description: 构造函数</p>
* ${tags}
*/
</template><template autoinsert="true" context="filecomment_context" deleted="false" description="已创建的 Java 文件的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/**   
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}(用一句话描述该文件做什么)
* @author DAIGUANGJIU    
* @date ${date} ${time}
* @version V1.0   
*/
</template><template autoinsert="true" context="settercomment_context" deleted="false" description="setter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/**
* @param ${param} 要设置的 ${bare_field_name}
*/</template><template autoinsert="true" context="typecomment_context" deleted="false" description="创建的类型的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/**
* @author ${user}
*
* ${tags}
*/</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="代表方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/**
* ${tags}
* ${see_to_target}
*/</template><template autoinsert="true" context="overridecomment_context" deleted="false" description="覆盖方法的注释" 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="methodcomment_context" deleted="false" description="非覆盖方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/**
* ${tags}
*/</template></templa
<?xml version="1.0" encoding="UTF-8"?><templates><template autoinsert="true" context="fieldcomment_context" deleted="false" description="字段的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/**
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
*/
</template><template autoinsert="true" context="gettercomment_context" deleted="false" description="getter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/**
* @return ${bare_field_name}
*/
</template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="创建的构造函数的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/**
* <p>Title:${file_name} </p>
* <p>Description: 构造函数</p>
* ${tags}
*/
</template><template autoinsert="true" context="filecomment_context" deleted="false" description="已创建的 Java 文件的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}(用一句话描述该文件做什么)
* @author DAIGUANGJIU  
* @date ${date} ${time}
* @version V1.0
*/
</template><template autoinsert="true" context="settercomment_context" deleted="false" description="setter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/**
* @param ${param} 要设置的 ${bare_field_name}
*/</template><template autoinsert="true" context="typecomment_context" deleted="false" description="创建的类型的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/**
* @author ${user}
*
* ${tags}
*/</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="代表方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/**
* ${tags}
* ${see_to_target}
*/</template><template autoinsert="true" context="overridecomment_context" deleted="false" description="覆盖方法的注释" 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="methodcomment_context" deleted="false" description="非覆盖方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/**
* ${tags}
*/</template></templa

例子2:
<?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>

本文来自CSDN博客,转载请标明出处:http://blog.csdn.net/ahhsxy/archive/2009/09/11/4542682.aspx

分享到:
评论

相关推荐

    Eclipse Java注释模板设置详解

    ### Eclipse Java注释模板设置详解 在开发过程中,良好的代码注释习惯对于提高代码的可读性和维护性具有重要作用。Eclipse作为一款流行的Java集成开发环境(IDE),提供了丰富的功能来帮助开发者更好地管理代码和...

    eclipse java注释模板

    Eclipse Java注释模板设置详解 Eclipse Java注释模板设置详解 设置注释模板的入口: Window-&gt;Preference-&gt;Java-&gt;Code Style-&gt;Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一...

    Eclipse Java注释模板.txt

    #### 三、Eclipse Java注释模板详解 下面将对Eclipse中几种常见的注释模板进行详细说明: ##### 1. 文件注释(File Comment) 文件注释通常位于每个Java文件的开头,用于描述该文件的基本信息。示例如下: ```java...

    Eclipse/MyEclipse Java注释模板设置详解

    这篇详细的教程将深入讲解如何在Eclipse和MyEclipse中设置Java注释模板,以提高开发效率和代码规范性。 一、Eclipse与MyEclipse的区别 Eclipse是一款开源的IDE,而MyEclipse是其商业版本,包含了更多的企业级开发...

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

    编辑注释模板的方法:Window-&gt;Preference-&gt;Java-&gt;Code Style-&gt;Code Template 然后展开Comments节点就是所有需设置注释的元素啦。 下载该文件后选择右侧Import导入该文件就创建模板成功了. 可以点击每一个选项根据...

    eclipse注释模板及导入

    ### Eclipse注释模板详解与导入方法 在软件开发过程中,良好的代码注释习惯不仅能够提升代码的可读性,还能方便后期的维护和重构。Eclipse作为一款广泛使用的集成开发环境(IDE),提供了丰富的功能来支持开发者的...

    myeclipse/eclipse设置java文档注释

    为了实现统一的 Java 文档注释风格,我们可以利用 Eclipse 的 Code Templates 功能来自定义注释模板。下面将详细介绍如何在 Eclipse 中配置这些模板: 1. **打开 Code Templates 配置界面** - 打开 Eclipse,依次...

    eclipse 注释模板

    **Eclipse 注释模板详解** 1. **创建和管理注释模板** 在Eclipse中,你可以通过`Window` -&gt; `Preferences` -&gt; `Java` -&gt; `Code Style` -&gt; `Code Templates`路径来访问和管理注释模板。这里分为三类:`Comments` -&gt;...

    IDEA 类和方法注释模板设置(Windows版).pdf

    ### IDEA类和方法注释模板设置知识点详解 #### 类注释模板设置 1. **模板作用** 类注释模板的作用是在创建Java类文件时,自动添加标准注释信息,从而规范代码结构,提高代码的可读性和可维护性。 2. **设置流程*...

    eclipse 配置JAVA注释

    Eclipse 配置 Java 注释模板详解 Eclipse 是一个功能强大且广泛使用的集成开发环境(IDE),其中 Java 是其支持的主要编程语言之一。为了提高代码的可读性和可维护性,添加合适的注释是非常重要的。Eclipse 提供了...

    eclipse 与myeclipse 注释规范设置

    最后,在`Code Templates`对话框中选择`Code -&gt; New Java files`,可以设置新建Java文件时的注释模板: ```plaintext ${filecomment} ${package_declaration} /** * @Title: ${file_name} * @Package ${package_...

    eclipse快捷键与模板

    ### Eclipse 快捷键与模板详解 #### 一、引言 在软件开发过程中,工具的熟练使用能够显著提升工作效率。Eclipse作为一款强大的开源Java集成开发环境(IDE),提供了丰富的快捷键和模板功能,帮助开发者高效编写代码...

    Eclipse的快捷键以及各个注释的快捷键

    Eclipse快捷键和文档注释设置详解 Eclipse是一款功能强大且广泛使用的集成开发环境(IDE),它提供了许多实用的快捷键来提高开发效率。同时,Eclipse也提供了丰富的文档注释功能,帮助开发者更好地记录和管理代码。...

    Java的注释

    本文将详细介绍几种常见的Java注释方式及其用途,并通过实例展示如何设置Eclipse IDE中的注释模板,帮助开发者更好地管理和组织代码。 #### 一、Java注释概述 Java提供了三种类型的注释: 1. **单行注释(//)**:...

    eclipse增加getset方法根据字段注释自动生成中文注释功能.docx

    除了修改`GetterSetterUtil`类外,还需要调整Eclipse的注释模板设置,以确保自动生成的注释符合预期。 1. 打开Eclipse,依次点击菜单`Window -&gt; Preferences -&gt; Java -&gt; Code Style -&gt; Code Templates`。 2. 在右侧...

    Eclipse中设置在创建新类时自动生成注释

    在Eclipse这一强大的集成开发环境(IDE)中,设置自动生成注释的功能是提升编码效率、维护代码可读性及专业性的有效手段。对于初学者乃至资深开发者而言,掌握如何在创建新类时自动添加注释,不仅能节省时间,还能...

    eclipse自动注释

    ### Eclipse自动注释功能详解 #### 一、概述 在软件开发过程中,代码注释是极为重要的一个环节,它能够帮助开发者更好地理解代码逻辑及功能实现。Eclipse作为一款广泛使用的开源集成开发环境(IDE),提供了强大的...

    maven-javadoc-plugin 中文 注释 API 解决乱码 pom xml

    ### Maven-javadoc-plugin 中文注释 API 解决乱码及时间问题详解 #### 一、背景介绍 在软件开发过程中,API文档对于提高代码可读性、方便团队成员之间的交流至关重要。Maven作为一款强大的自动化构建工具,在项目...

Global site tag (gtag.js) - Google Analytics