`
liss
  • 浏览: 844639 次
  • 性别: Icon_minigender_1
  • 来自: 广州
社区版块
存档分类
最新评论

Eclipse/MyEclipse 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>

为了您的安全,请只打开来源可靠的网址

打开网站    取消

来自: http://hi.baidu.com/411213866/blog/item/77c2160ae9475fc33ac763e1.html
分享到:
评论

相关推荐

    eclipse 与myeclipse 注释规范设置

    ### Eclipse与MyEclipse注释规范设置详解 在软件开发过程中,良好的代码注释习惯对于提高代码可读性、维护性和团队协作效率至关重要。本文将详细介绍如何在Eclipse与MyEclipse IDE中设置规范化的注释格式,帮助...

    myeclipse/eclipse设置java文档注释

    ### myEclipse/Eclipse 设置 Java 文档注释详解 #### 一、引言 在进行软件开发的过程中,良好的代码注释习惯对于提升代码可读性和维护性至关重要。特别是在团队协作中,规范化的文档注释能够帮助团队成员更快地理解...

    Java软件开发实战 Java基础与案例开发详解 3-9 MyEclipse工具介绍 共13页.pdf

    ### Java软件开发实战:MyEclipse工具介绍 #### 3-9 MyEclipse工具介绍 在Java编程领域,“工欲善其事,必先利其器”这句话同样适用。选择一款优秀的开发工具对于提高开发效率至关重要。MyEclipse作为一款功能强大...

    myeclipse优化设置

    ### MyEclipse优化设置知识点详解 #### 一、关闭自动更新功能 为了提高启动速度,可以关闭自动更新功能。操作步骤如下: 1. 打开`Window`菜单下的`Preferences`选项。 2. 导航至`General` &gt; `Startup and Shutdown...

    myeclipse 快捷键使用方式

    MyEclipse是一款非常流行的集成开发环境(Integrated Development Environment, IDE),它基于Eclipse平台并添加了诸多增强功能,特别适用于Java Web应用程序的开发。通过使用MyEclipse,开发者可以高效地进行代码...

    Myeclipse配置环境

    - **类型注释模板:** 设置类的注释模板,如包含描述、作者、公司等信息。 **12. Maven工程创建与发布:** - **创建Maven工程:** 注意在创建过程中,由于MyEclipse2013的限制,可能需要进行额外的操作才能将其...

    myeclipse+hibernate项目配置包

    1. **MyEclipse**: MyEclipse是Eclipse的商业版本,它包含了对Java、J2EE、Web、数据库开发等的支持,提供了一系列的工具,如代码生成器、数据库连接工具、部署工具等。它还提供了图形化的界面,用于创建、配置和...

    Java开发工具

    ### Java开发工具:Eclipse 的使用详解 #### 一、Java 开发工具概述 Java作为全球最流行的编程语言之一,在企业级应用开发中占据着重要地位。为了提高开发效率,选择合适的开发工具至关重要。其中,Eclipse是一款...

    myeclipse快捷键大全

    选择“Window” -&gt; “Preferences”,然后选择“Java” -&gt; “Code Style” -&gt; “Code Templates”,在“Comments”分类下,编辑模板,删除不必要的默认注释模板。 6. **为什么有时文件不会自动刷新显示?** 如果...

    myEclipse快捷键.txt

    - **应用场景**:创建新文件时自动添加预设的注释模板,节省时间并保持一致性。 #### 三、其他常用快捷键补充 ##### 1. Ctrl+Space - **功能描述**:代码提示。 - **应用场景**:输入代码时提供自动完成建议,包括...

    Myeclipse的Spket插件

    MyEclipse是一款强大的Java集成开发环境(IDE),它基于Eclipse平台,提供了丰富的功能,支持多种语言的开发,包括Java、JSP、JavaScript等。为了进一步提升在JavaScript开发中的效率和体验,MyEclipse引入了Spket...

    java中的快捷键

    ### Java开发环境中常用快捷键详解 在Java开发过程中,熟练掌握和运用快捷键可以极大地提高工作效率,减少重复劳动。本文将详细介绍与Java编程相关的Eclipse和MyEclipse环境下的快捷键,帮助开发者更加高效地进行...

    MyEclipse 快捷键

    MyEclipse 是一个基于 Eclipse 的强大 IDE,尤其适用于 Java 开发者。熟练掌握 MyEclipse 的快捷键对于提高编程效率至关重要。下面将详细介绍 MyEclipse 的常用快捷键及其功能。 #### 一、编辑操作 1. **调整编辑...

    my eclipse快捷键大全

    ### MyEclipse快捷键大全详解 在开发过程中,熟练掌握并运用快捷键可以极大地提高工作效率。MyEclipse作为一款基于Eclipse平台的增强版集成开发环境(IDE),提供了丰富的功能和快捷键支持,使得开发者能够更高效、...

    MyEclipse快捷键大全

    MyEclipse作为一款基于Eclipse平台的增强版Java IDE,提供了丰富的功能和强大的插件支持。本文将详细介绍MyEclipse中的常用快捷键,帮助开发者更快地掌握这些技巧,从而提高编程效率。 #### 二、编辑与操作类快捷键...

    myeclipse的快捷键

    ### MyEclipse快捷键详解 #### 一、概述 MyEclipse是一款强大的集成开发环境(IDE),主要用于Java应用程序的开发。它集成了Eclipse平台,并提供了丰富的插件和功能,如代码编辑、调试、构建、部署等。对于提高...

    myeclipse快捷键

    15. **Alt+Shift+j**:添加文档注释,用于快速生成Javadoc注释模板。 #### 三、查找与替换 1. **Ctrl+F**:全局查找并替换,用于在整个工程中搜索特定文本并进行替换操作。 2. **Ctrl+Shift+K**:文本编辑器中...

Global site tag (gtag.js) - Google Analytics