`
lsw521314
  • 浏览: 6752 次
  • 性别: Icon_minigender_1
  • 来自: 上海
最近访客 更多访客>>
社区版块
存档分类
最新评论

eclipse/myeclipse注释模板的修改

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

首先要知道这些是干嘛的:
/**
* @param ${tags}
* @return ${date} == 2011-11-17
*$$
*${enclosing_method}   ==  damo
*${enclosing_type}  ==  类名
*${file_name}   == 类名.java
*${return_type}  ==  返回值类型(或者void)
*${time}    ==  下午02:04:07
*${todo}    ==  待办事情
*${year}    == 获取年
*${user}   ==   Administrator(可改成自己的名字)
*----------------
*${param} ==  参数名
*${bare_field_name}  == 属性名
*/

/**  
*   
* 项目名称:${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注释模板"。 1. **Eclipse 和 MyEclipse 注释模板** Eclipse 和 MyEclipse 都允许用户创建和管理自己的代码...

    Eclipse/MyEclipse注释模板和格式化模板的使用

    Eclipse和MyEclipse作为Java开发的主流工具,提供了丰富的自定义功能,其中之一就是注释模板和格式化模板的设置。本文将深入探讨如何利用这些模板来优化代码编写体验。 注释模板在编程时非常实用,它们允许开发者...

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

    在Java开发过程中,Eclipse和MyEclipse作为两款流行的集成开发环境(IDEs),提供了许多便利的功能,其中包括自定义代码注释模板。这篇详细的教程将深入讲解如何在Eclipse和MyEclipse中设置Java注释模板,以提高开发...

    Eclipse/MyEclipse代码注释模板文件

    可以选择Window-&gt;Preferences-&gt;Java-&gt;Code Style-&gt;Code Templates下的Comments,然后点击Import导入本文件,即可完成代码注释模板的导入.以后在需要注释的类或方法前使用敲入/*回车,便可以自动带入注释模板.

    eclipse|myeclipse注释模板

    一个优秀的注释模板,修改成自己的名字,在eclipse,myeclispse里导入这个模板就好,会显示类名、备注 、时间、坐着、版本、使用的jdk版本。使用就会爱上的模板。

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

    本文将重点介绍“Java编译工具MyEclipse的注释模板代码”及其相关知识点。 首先,MyEclipse是Eclipse的一个商业版本,它集成了更多的功能,特别是对Java EE开发的支持,包括Web、Java、JSP、Struts、Spring等。...

    如何控制代码格式(eclipse&myeclipse通用版)

    ### 如何控制代码格式(Eclipse & MyEclipse 通用版) #### 一、概述 在软件开发过程中,保持良好的代码格式对于提高代码可读性和维护性至关重要。Eclipse 和 MyEclipse 是两款广泛使用的 Java 集成开发环境(IDE)...

    myeclipse/eclipse设置java文档注释

    为了实现统一的 Java 文档注释风格,我们可以利用 Eclipse 的 Code Templates 功能来自定义注释模板。下面将详细介绍如何在 Eclipse 中配置这些模板: 1. **打开 Code Templates 配置界面** - 打开 Eclipse,依次...

    myeclipse简单注释模板(更新)

    MyEclipse作为一款强大的Java集成开发环境,提供了许多定制化功能来提升编程体验,其中之一就是自定义注释模板。本篇将详细介绍如何利用"Myeclipse简单注释模板(更新)"进行高效编码。 首先,我们关注的两个文件...

    Eclipse快捷键总结

    #### 一、Eclipse与MyEclipse简介 - **Eclipse**: 是一款开源免费的集成开发环境(IDE),支持多种编程语言,如Java、C++等。 - **MyEclipse**: 基于Eclipse平台的一款功能强大的商业Web应用开发工具,除了Eclipse的...

    myeclipse与eclipse注释文件,格式文件导入

    注释文件通常包含预定义的代码注释模板,如类、方法、变量等的注释模板,它们可以极大地提高开发效率,使代码注释更规范、更一致。而“格式文件”则指的是代码格式化规则,例如缩进、空格、换行等,它能确保团队成员...

    如何修改MyEclipse方法注释

    使用自定义模板时,当你创建新的类或方法时,记得勾选“Generate comments”选项,MyEclipse会自动插入你定义好的注释模板内容。 总结来说,MyEclipse的代码模板功能使得编写规范的注释变得简单高效。通过自定义...

    eclipse,myeclipse快捷键大全

    ### Eclipse与MyEclipse快捷键大全:提升开发效率的关键 在软件开发领域,Eclipse与MyEclipse作为广受欢迎的集成开发环境(IDE),为Java开发者提供了强大的支持。熟练掌握这些IDE中的快捷键,能够显著提升编码效率...

    Eclipse自定义模板设置

    自定义代码模板功能允许开发者定义自己的代码模板,例如类注释模板、方法注释模板等,而自定义标签模板则允许开发者定义自己的标签模板,例如@author、@date 等。 要使用 Eclipse 的自定义模板设置,首先需要打开 ...

    myeclipse 格式化模板

    通过修改`codetemplates.xml`,你可以定义自己的模板,包括注释模板、代码块模板,甚至可以添加自定义的快捷键,使得编码更加高效。 在实际开发中,团队通常会共享一个统一的`eclipse-formatter.xml`和`code...

    myeclipse添加统一注释模版

    这篇博客将详细解释如何在MyEclipse中设置和使用自定义的注释模板。 首先,我们需要了解什么是代码模板。代码模板是预定义的代码段,可以在编写代码时快速插入到当前编辑器中。它们可以用于常见的注释结构,如类、...

    Eclipse_+_MyEclipse_使用指南.doc

    用户界面简洁,易于理解,可以自定义注释模板和代码格式化规则。Eclipse的重构功能可以帮助开发者安全地修改代码结构而不影响程序逻辑。任务标记功能则能帮助跟踪待办事项,过滤功能则可以按需显示或隐藏。通过查看...

    重装myeclipse后常用的设置模板

    - 如果需要更新Servlet模板,可以找到MyEclipse安装目录下的`\common\plugins`,替换`com.genuitec.eclipse.wizards_9.0.0.me201108091322.jar`文件。 4. **创建Filter模板**: - 在MyEclipse中,可以通过`New -&gt;...

Global site tag (gtag.js) - Google Analytics