`

Eclipse编码模版设置

 
阅读更多

http://andli.iteye.com/upload/picture/pic/100149/c68ebd2d-1109-3b74-aac0-83de7bc7ad4c.png

 

/**
* @author lilin
* @date ${date} ${time}
* @annotation
*/


 

 

 

 

Files

/**

* @author lilin

* @date ${date} ${time}

* @Title: ${file_name}

* @Package ${package_name}

* @Description: ${todo}

* @version V1.0

*/

 

Types

/**

* @author lilin

* @date ${date} ${time}

* @ClassName: ${type_name}

* @Description: ${todo}

* ${tags}

*/

 

Method

/**

* @author lilin

* @date ${date} ${time}

* @Title: ${enclosing_method}

* @Description: ${todo}

* @param ${tags}

* @return ${return_type}

* @throws

*/

 

<!--EndFragment-->

 

设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍:
文件(Files)注释标签:
/**  
* @Project: ${project_name}
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}
* @author shenyanghong ahong2011@gmail.com
* @date ${date} ${time}
* @Copyright: ${year} www.1000chi.com Inc. All rights reserved.
* @version V1.0  
*/
类(Types)注释标签(类的注释):
/**
 * @ClassName ${type_name}
 * @Description ${todo}
 * @author shenyanghong ahong2011@gmail.com
 * @date ${date}
 * ${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} 
*/
简单模板例1: 
<?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 jeffshaw email:jeff_chon@hotmail.com     
* @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 jeffshaw email:jeff_chon@hotmail.com   
* @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: jeffwhaw email:jeff_chon@hotmail.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: jeffshaw email:jeff_chon@hotmail.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: jeffshaw email:jeff_chon@hotmail.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: jeffshaw email:jeff_chon@hotmail.com
     * @version: ${date} ${time} 
     */ 
    </template> 
</templates>
 
分享到:
评论

相关推荐

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

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

    Eclipse 代码模板设置

    例如,eclipse.2.7.2-codetemplates.xml是针对Eclipse 2.7.2版本的代码模板配置,STS2.7.2-codetemplates.xml可能对应Spring Tool Suite 2.7.2版本,而MyEclipse10-codetemplates.xml则属于MyEclipse 10的模板设置。...

    eclipse模板设置

    使用模板设置不仅可以提高编码速度,还能减少错误,保持代码整洁。建议开发者根据项目规范,定期更新和优化模板,确保每次新建的代码都能遵循一致的风格和标准。 7. **其他语言支持**: 虽然Eclipse最初是为Java...

    eclipse-编码规范系列(一):Eclipse Code Templates设置 - CSDN博客1

    Eclipse是一款广泛使用的Java集成开发环境,其强大的功能之一就是能够根据个人或团队的编码规范进行自定义设置。本文将详细介绍如何在Eclipse中设置Code Templates,以实现代码的自动格式化和一致性。 编码规范是...

    Eclipse模版(导入自己的Eclipse模版)

    "Eclipse模版(导入自己的Eclipse模版)"这个资源就是提供了这样的便利性,让用户可以将个人定制的模板导入到Eclipse中。 模板系统是Eclipse中的一个重要特性,它允许用户创建自己的代码模板,这些模板可以在编写代码...

    eclipse 常用设置空间模板

    例如,你可以为常见的类构造函数、异常处理、循环结构等设置模板,只需输入缩写或通过特定快捷键,Eclipse就会自动补全完整的代码。 2. **如何导入模板** 要导入这个压缩包中的模板,首先需要在Eclipse中进行以下...

    Eclipse Java 注释模板

    通过以上方式,你可以根据实际需求定制自己的Java注释模板,使编码过程更加高效且规范。对于团队协作来说,共享一致的注释模板也能进一步提高沟通效率,减少不必要的误解。 总之,Eclipse Java注释模板是提升开发...

    编码规范及eclipse设置

    另一方面,`codetemplates.xml`文件则可能包含了Eclipse中的代码模板设置。代码模板允许开发者为常见的代码块(如构造函数、getter/setter、循环等)预设模板,只需输入简短的缩写,Eclipse就会自动生成完整代码,...

    Eclipse 代码注释模板

    在`codetemplates.xml`中,这些模板以XML格式存储,每个模板都有一个唯一的ID和相应的占位符,如`${cursor}`表示光标位置,`${date}`会插入当前日期,`${author}`则会填充默认的作者信息。 为了使用自定义的`code...

    eclipse编码规范

    Eclipse,作为一个广泛使用的Java集成开发环境(IDE),提供了强大的代码规范设置功能,帮助开发者遵循一致的编码风格。本篇文章将深入探讨Eclipse中的`codestyle`和代码格式设置,以及如何通过`formatter.xml`和`...

    关于eclipse的ftl模板的技巧设置方法

    ### 关于Eclipse中FTL模板的技巧设置方法 #### 概述 FreeMarker Template Language (FTL) 是一种用于生成文本输出的模板语言。它广泛应用于Java Web开发中,帮助开发者快速构建动态网页。然而,对于开发者而言,...

    java编码规范,eclipse 导入xml,有说明导入方式

    在导入"eclipse 导入xml"的过程中,我们可以利用Eclipse的设置导入功能来应用这些XML配置文件,以定制代码格式化和模板规则。这里有两份XML文件: 1. Eclipse_CodeFormatter.xml:这是Eclipse的代码格式化配置文件...

    eclipse java code Format模版

    Eclipse社区还开发了许多第三方代码格式化插件,如"Google Java Formatter",提供了更严格的代码风格,可以替代Eclipse默认的代码格式化工具。安装插件后,可以根据插件提供的设置进行配置。 总之,Eclipse Java ...

    Android eclipse 自动补全的设置

    除了上述基本设置,Eclipse还允许你自定义代码模板。在"Java &gt; 代码样式 &gt; 代码模板"中,你可以创建自己的代码片段,如常用的构造函数、循环或异常处理。这些模板将在补全列表中显示,提高编码速度。 此外,`a.epf`...

    eclipse设置标准格式模板xml

    eclipse设置标准格式模板

    eclipse 模板配置教程

    Eclipse还允许你为模板设置标签,这样可以在特定类型的文件中快速访问。在模板列表中,选择模板,点击`Edit...`,在`Applies To`选项中,可以选择模板适用的文件类型,比如Java、XML等。 **源码与工具** 模板功能...

    Eclipse格式模板XML文件

    6. **命名约定**:Eclipse还支持设置变量、类、方法等命名规则,遵循一定的编码规范,如驼峰命名法、下划线命名法等。 7. **其他选项**:包括行的最大长度、换行策略、空行处理等,都是Eclipse格式模板中可配置的...

    eclipse注释模版以及说明

    你可以设置模板以适应个人或团队的编码规范。例如,对于Java的类注释,可能希望包含版权信息、作者、创建日期和描述。你可以设置模板如下: ``` /** * ${copyright} * * @author ${user} * @since ${date} ...

    Eclipse编码格式.7z

    "Eclipse编码格式.7z"这个压缩包包含了两个关键文件,用于定义和管理Eclipse中的Java代码格式和注释模板。 1. **Eclipse_CodeFormatter.xml**: 这个文件是Eclipse的代码格式化器配置文件,它定义了Java源代码的...

    eclipse代码模板

    其中,代码模板和注释模板是Eclipse中非常实用的功能,帮助开发者遵循一定的编码规范,快速生成标准化的代码和注释。 代码模板是Eclipse中的一大亮点,它允许用户自定义常用的代码段,并在编写代码时通过快捷键或者...

Global site tag (gtag.js) - Google Analytics