`

eclipse自定义注释

 
阅读更多

Java   --> Code Style   --> Code Template   -->Comments   -->types

----------------------------------------------------------------------------------------------------------------------------

设置注释模板的入口: 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>

  • 大小: 51.2 KB
分享到:
评论

相关推荐

    Eclipse注释模板自定义

    本篇文章将详细探讨如何在Eclipse中自定义注释模板,以及如何通过`eclipse.ini`配置文件来管理版权信息和团队设置。 一、Eclipse注释模板自定义 1. **打开Eclipse注释模板设置** 要自定义注释模板,首先需要进入...

    如何配置Eclipse自定义注释

    Eclipse作为一个强大的Java集成开发环境(IDE),提供了丰富的注释功能,包括自定义注释模板。本篇将详细介绍如何在Eclipse中配置自定义注释,以提高编码效率和代码规范性。 首先,我们需要了解Eclipse的注释类型。...

    eclipse中自定义注释的格式(直接导入即可)

    可以按照自己的意愿编辑自定义注释 工程-&gt;右键-&gt;Properties-&gt;Java code style -&gt; code Templates-&gt; import 就ok了

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

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

    eclipse格式化和自动注释模板

    eclipse代码格式化模板 在Eclipse中:Windows -&gt; Preferences -&gt; java -&gt; Code Style -&gt; Formatter -&gt; Import 自动格式化大括弧自动对齐模板。注释也好看,自用模板

    MyEclipse/Eclipse自定义模板XML

    MyEclipse/Eclipse自定义模板XM MyEclipse/Eclipse自定义模板XM 直接导入就可以使用了 安装方法: 打开eclipse/myeclipse 选择 window--&gt;Preferences--&gt;JAVA--&gt;Code Style--&gt;Code Templates 右边点Import 选择你写好...

    Eclipse Java 注释模板

    下面我们将深入探讨Eclipse Java注释模板的使用方法、重要性以及如何进行自定义配置。 首先,Eclipse的Java注释模板允许开发者预先设定一系列常用的注释格式,如类、方法、变量的注释模板。这些模板包含了如作者、...

    Eclipse 代码注释模板

    在Eclipse中,用户可以自定义代码注释模板,这通常涉及到类、方法、变量等不同类型的注释结构。`codetemplates.xml`文件就是存储这些自定义模板的配置文件,通过编辑这个文件,我们可以定制符合个人或团队编码规范的...

    Eclipse Java注释模板.txt

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

    Eclipse自定义模板设置

    Eclipse 自定义模板设置 Eclipse 是一个功能强大且广泛使用的集成开发环境(IDE),它提供了许多有用的功能来提高开发效率和代码质量。其中,自定义模板设置是一个非常重要的功能,它允许开发者根据自己的需求和...

    eclipse自动注释插件JAutodoc

    JAutodoc是一款针对Eclipse的自动注释插件,它极大地简化了这个过程,允许程序员自定义注释模板,自动为类、方法、变量等添加注释。 JAutodoc的主要特点包括: 1. **自动化注释生成**:该插件能够根据用户设定的...

    Eclipse 添加注释模板

    要添加自定义注释模板,我们需要进入Eclipse的首选项设置。点击菜单栏上的“Window” -&gt; “Preferences”,在打开的窗口中,展开“General” -&gt; “Editors” -&gt; “Text Editors” -&gt; “Annotations”。在这里,你...

    eclipse代码注释风格

    Eclipse允许用户自定义注释模板,以适应不同场景的需求。例如,你可以为类、方法、变量等创建不同的注释模板。这些模板可以包含日期、作者信息、版权声明等内容。在`Window &gt; Preferences &gt; Java &gt; Code Style &gt; ...

    Eclipse代码注释模板——code templates

    总结,Eclipse的代码注释模板是提高编程效率的重要工具,它允许用户根据个人或团队规范创建和使用自定义注释格式。通过`convertion.xml`和`codetemplates.xml`文件,我们可以管理和共享这些模板,确保代码风格的一致...

    eclipse自定义代码块折叠

    安装完成后,重启Eclipse,你会发现在编辑器的代码区域多了一个新的图标或选项,用于激活自定义折叠功能。通常,这个图标会显示为一个带有下划线的字母"A"。点击这个图标,可以打开折叠配置界面。在这里,你可以设置...

    eclipse文档注释内容修改.rar

    除了手动修改,Eclipse还提供了代码模板功能,允许你自定义常用的注释模板。在`Window &gt; Preferences &gt; Java &gt; Code Style &gt; Code Templates`中,你可以创建、编辑和应用各种模板,比如类、方法和构造函数的注释。 ...

    eclipse注释模板及导入

    要将自定义的注释模板导入到Eclipse中,可以按照以下步骤操作: 1. 打开Eclipse,选择`Window` &gt; `Preferences`(Windows系统)或`Eclipse` &gt; `Preferences`(Mac系统)进入偏好设置界面。 2. 在偏好设置窗口中,...

    Eclipse Java注释模板设置详解

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

    eclipse 中的注释 快捷键

    此外,通过Eclipse的设置菜单(`Windows -&gt; Preferences -&gt; Workbench -&gt; Keys`),用户可以根据个人习惯自定义快捷键,进一步个性化开发环境。总之,高效利用Eclipse快捷键,是每一位程序员提高工作效率、优化编程...

    eclipse经典注释模板

    Eclipse是一款广泛使用的Java集成开发环境(IDE),它拥有丰富的功能和高度可定制性,其中就包括了自定义注释模板和代码格式化模板。这些模板对于提高开发效率、保持代码一致性以及提升团队协作有着重要作用。 注释...

Global site tag (gtag.js) - Google Analytics