`

Myeclipse项目注释设置(转)

    博客分类:
  • java
 
阅读更多
.
Window --> Java --> Code Style --> Code Templates --> Comments --> types --> Edit 

/**   
*    
* 项目名称:${project_name}   
* 类名称:${type_name}   
* 类描述:   
* 创建人:${user}   
* 创建时间:${date} ${time}   
* 修改人:${user}   
* 修改时间:${date} ${time}   
* 修改备注:   
* @version    
*    
*/

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

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

*/

简单模板例子:

view plaincopy to clipboardprint?

<?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:

view plaincopy to clipboardprint?

<?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 与myeclipse 注释规范设置

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

    MyEclipse自动注释配置文件

    本文将详细介绍如何利用"MyEclipse自动注释配置文件"进行高效且规范的代码注释。 标题中的"MyEclipse自动注释配置文件"实际上是指一个名为"codetemplates.xml"的文件,这个文件包含了预定义的代码注释模板。这些...

    myeclipse注释模板的修改 自动生成注释

    本篇文章将详细解析如何在MyEclipse中修改注释模板,实现自动生成符合个人或团队编码规范的注释。 首先,我们来理解一下什么是注释模板。在编程中,注释是用来解释代码功能、用途以及编写逻辑的文字,对于代码的...

    myeclipse简单注释模板

    本教程将详细讲解如何在MyEclipse中设置和使用简单的注释模板。 首先,我们来看到两个关键文件:"code_templates.xml" 和 "comments_templates.xml"。这两个XML文件是MyEclipse中存储代码和注释模板的配置文件。`...

    MyEclipse注释模板

    通过设置个人化的模板,你可以快速创建符合公司或项目编码规范的注释,提高团队协作效率。 二、创建和编辑注释模板 1. **打开设置**:在MyEclipse中,可以通过“Window” -&gt; “Preferences” -&gt; “Java” -&gt; ...

    MyEclipse配置注释风格

    首先,打开MyEclipse的设置界面,可以通过菜单栏选择“Window” -&gt; “Preferences”,进入首选项设置窗口。在左侧的树形结构中,找到并展开“Java”选项,然后点击“Code Style”,接着选择“Code Templates”。 1....

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

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

    myeclipse/eclipse设置java文档注释

    2. **文件 (Files) 注释设置** - 点击 **Files** 并选择 **Edit** 进入编辑模式。 - 可以设置以下变量: - `${file_name}`:表示文件名称。 - `${package_name}`:表示包名。 - `${todo}`:用于简短描述文件的...

    如何修改MyEclipse方法注释

    在MyEclipse中修改方法注释是一个非常实用的功能,它能帮助程序员快速生成标准化的注释,提高代码的可读性和维护性。下面将详细介绍如何进行设置和自定义注释模板。 首先,打开MyEclipse的首选项设置,可以通过以下...

    Myeclipse多行注释快捷键

    ### MyEclipse多行注释快捷键详解 在软件开发过程中,提高开发效率是每个开发者追求的目标之一。本文将详细介绍MyEclipse中的多行注释快捷键以及其他与代码编辑、格式化、查找替换等相关的快捷键,帮助开发者更加...

    Myeclipse10.7 封装类 自动设置 Get Set方法中文注释设置

    总之,熟练掌握Myeclipse的代码生成和自定义注释设置,能够显著提高开发效率,同时保持代码的整洁和可读性。在实际工作中,根据团队习惯和项目需求,适时调整这些设置,能够进一步提升开发体验。

    myeclipse简单注释模板(更新)

    在IT行业中,开发工具的效率往往直接影响到程序员...通过编辑"code_templates.xml"和"comments_templates.xml",或直接在MyEclipse的首选项中设置,你可以根据项目需求定制专属的代码和注释模板,让编程更加得心应手。

    myeclipse注释文件(包括使用说明)

    总的来说,这个压缩包将为你提供有关MyEclipse注释功能的深入理解和使用指南,帮助你在项目开发中实现高效、规范的代码注释。通过熟练运用这些工具和技巧,你可以提升个人编程技能,同时增强团队间的协作效率。

    eclipse/Myeclipse注释模板

    本文将详细介绍如何在 Eclipse 和 MyEclipse 中设置和使用注释模板,以及如何导入和配置提供的 "eclipse注释模板"。 1. **Eclipse 和 MyEclipse 注释模板** Eclipse 和 MyEclipse 都允许用户创建和管理自己的代码...

    MyEclipse中设置java注释模板的方法.docx

    在 MyEclipse 这个强大的集成开发环境中,设置自定义的 Java 注释模板可以极大地提高开发效率,使得代码更具可读性和一致性。下面将详细解释如何进行这些设置以及各个模板的作用。 1. **找到设置位置**: 首先,...

    eclipse/myeclipse注释行模板

    打开eclipse/myeclipse 选择 window--&gt;Preferences--&gt;JAVA--&gt;Code--&gt;Code Templates 右边点Import 选择下载的本资源解压后的的.xml文件 导入进去即可 使用方法: 创建新类的时候,勾上“Generate comments”选项...

    eclipse myeclipse java 代码 注释 模板

    本主题聚焦于"Eclipse MyEclipse Java 代码注释模板",这是一种强大的工具特性,它允许程序员自定义代码片段和注释模板,以便在编码时快速插入。以下是对这一主题的详细阐述。 1. **Eclipse MyEclipse**: Eclipse...

    myeclipse添加统一注释模版

    总之,通过自定义代码模板,MyEclipse使得在项目中保持一致的注释风格变得简单。无论是个人使用还是团队协作,这都是提高代码质量和团队效率的有效工具。掌握这一技巧,可以使你的编程工作更加高效和愉快。

    Java编译工具myeclipse注释模板代码

    在实际使用中,我们可以根据项目需求,为不同的代码元素(如类、接口、方法)设定不同的注释模板。例如,对于公共类,我们可以设置包含版权信息、作者、创建日期等内容的注释;对于方法,可以设置包括方法功能、参数...

Global site tag (gtag.js) - Google Analytics