`

【工程规范】Eclipse注释模板与规范

阅读更多

设置注释模板的入口: 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下的mybatis逆向工程

    - 自定义模板:可以根据项目需求自定义生成的Java类和XML文件的模板,以满足特定的编码风格和规范。 通过Eclipse和MyBatis逆向工程,开发者可以快速地为每个数据库表建立数据访问层,降低重复劳动,提高代码质量,...

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

    这里就是我们进行代码模板自定义的地方,包括但不限于方法、类、文件的注释模板。 #### 步骤三:编辑代码模板 在“Code Templates”界面中,找到“Code”分类下的“New Java files”,点击右侧的“Edit”按钮。此时...

    java编码规范及注释快捷键.doc

    - **方法注释快捷键**:IDEs如Eclipse或IntelliJ IDEA提供了注释生成快捷键,如`/**`+回车键,自动插入方法的Javadoc模板,便于快速添加注释。 #### 四、代码组织策略 - **变量排序**:按照访问级别从高到低排序,...

    基于Eclipse的代码开发准备

    本文将深入探讨如何利用Eclipse的代码格式化模板文件优化开发环境,提高编码规范性。 首先,Eclipse作为一款强大的Java集成开发环境,提供了丰富的自定义选项来满足不同开发者的需求。其中,`formatter.xml`文件...

    eclipse code formatter

    使用Eclipse Code Formatter,开发者可以自定义缩进方式(使用空格还是制表符,以及它们的数量),行宽限制,命名规则,括号位置,注释样式等多种格式设置。这些设置可以根据个人或团队的编码风格进行调整,确保整个...

    IDEA配置统一 java 类注释

    ##### 2.1 ECLIPSE与IDEA的差异 从题目中给出的信息可以看出,在Eclipse和IntelliJ IDEA之间存在一些细微的差别。例如,在Eclipse中使用的`${project_name}`、`${package_name}`等占位符,在IDEA中分别变为`${...

    Android编程规范

    Android 编程规范的整体原则包括约定、便于阅读、缩进、增加括号、折行、行宽限制、与工具集成、对 JavaDoc 的注释支持、Eclipse 的模板文件及配置、便于调试、一行一条语句、便于写作注释与语句不同行、减少重复...

    maven 逆向逆向工程

    8. **限制与挑战**:尽管Maven逆向工程可以极大地帮助开发者重构旧项目,但它并不能完全恢复原始的源代码和构建过程,特别是当源代码有复杂的注释、原始命名约定或非标准构建步骤时。此外,对于混淆过的代码,逆向...

    自定义 Hibernate Tools 的模板

    **自定义 Hibernate Tools 模板**是针对 Eclipse 开发环境中的 Hibernate 工具集进行的一种扩展,目的是在使用 Hibernate 逆向工程(Reverse Engineering)生成实体类时,能够根据数据库中的注释自动添加对应的注释...

    JAVA工程师浅蓝色个人面试求职模板.docx

    常见的编码规范包括命名规则、注释风格等。 3. **熟悉关系型数据库**: - 关系型数据库如MySQL、Oracle等是JAVA开发中不可或缺的一部分。熟练掌握SQL语言,能够编写高效的查询语句对于优化应用性能至关重要。 4. ...

    mybatis逆向工程

    8. **注释处理**:逆向工程支持在生成的代码中添加注释,这有助于理解代码的来源和用途,提升代码可读性。 9. **版本控制**:逆向工程生成的代码应当纳入版本控制系统,如Git,这样在团队协作时,每个人都能得到...

    mybatis的逆向工程

    将逆向工程集成到IDEA、Eclipse等开发工具,可以通过一键操作完成代码生成,进一步提升开发效率。 6. **最佳实践**: 在实际开发中,建议将逆向工程作为持续集成的一部分,每次数据库更新后自动运行,确保代码与...

    eclipse快捷键

    6. **显示注释**:`Shift+F2`,高亮显示或编辑当前选中的注释。 7. **查找类型**:`Ctrl+Shift+T`,快速查找并打开项目中的类型。 8. **查找变量声明**:`Ctrl+Shift+R`,找到变量的声明位置。 #### 编译与运行 1....

    Mybatis反向工程插件,模版

    总结来说,Mybatis反向工程插件是提高开发效率的重要工具,通过合理的配置和模版定制,可以生成符合项目规范的代码,减少重复劳动。熟练掌握这一功能,能帮助开发者更专注于业务逻辑的实现,提升开发效率和代码质量...

    Eclipse常用快捷键

    - **Ctrl+Alt+S**:除了基本的代码生成外,还可用于定制代码模板,包括注释、getter/setter等。 #### 搜索与替换 - **Ctrl+F**:全局搜索文本,在整个项目中查找特定的字符串或代码片段。 - **Ctrl+Shift+K**:替换...

    mybatis逆向工程代码

    4. **代码模板**:MyBatis逆向工程允许自定义生成的代码模板,可以调整字段注释、getter/setter方法等细节,以满足特定的编码风格。 5. **执行逆向工程**:通过运行MyBatis的Generator类,依据配置文件中的设置,...

    java code spec

    类和方法注释推荐使用Eclipse自动生成模板,填写功能说明。注释要求覆盖声明性变量、类定义、方法和成员变量,方法逻辑注释视复杂程度决定。类定义注释需包含作者、日期、功能描述、修改记录和版本信息,确保文档...

    JAVA开发规范

    JAVA开发规范是软件工程中确保代码质量和项目可持续性的关键组成部分。这一规范涵盖了编码风格、命名约定、代码格式、编程技巧等多个方面,旨在提高代码的可读性、可维护性和标准化水平。 ### 编程规范 #### 引言 ...

Global site tag (gtag.js) - Google Analytics