`

myeclipse设置注释格式

 
阅读更多

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>

分享到:
评论

相关推荐

    MyEclipse设置注释格式

    ### MyEclipse设置注释格式详解 在软件开发过程中,良好的代码注释习惯不仅能够提高代码的可读性,还能方便后期的维护与修改。MyEclipse作为一款强大的集成开发环境(IDE),提供了丰富的功能来帮助开发者管理和...

    myeclipse 设置注释格式化

    myeclipse 设置注释格式化myeclipse 设置注释格式化myeclipse 设置注释格式化myeclipse 设置注释格式化myeclipse 设置注释格式化

    Myeclipse自动注释设置

    例如,如果你的团队有特定的注释格式要求,可以在`Code Templates`中新建模板,输入相应的注释格式,并为其指定一个易记的名称。这样,每次需要使用自定义模板时,都可以方便地选择它。 在开发过程中,良好的注释...

    myeclipse开发注释自动生成

    在MyEclipse中,Methods注释设置是指在方法上添加注释的设置。具体步骤如下: 1. 打开MyEclipse,点击菜单“Window”-&gt;“Preferences”,打开Preference对话框。 2. 在Preference对话框中,选择“Java”-&gt;“Code ...

    MyEclipse6.5 注释类及方法等格式设置(Code Templates)

    本篇将详细介绍如何在`MyEclipse 6.5`中设置注释类、方法以及其他代码结构的格式,这主要通过`Code Templates`功能实现。 首先,`Code Templates`允许我们自定义代码模板,当创建新类、方法或者插入注释时,可以...

    eclipse 与myeclipse 注释规范设置

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

    MyEclipse自动注释配置文件

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

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

    MyEclipse的注释模板允许用户预先定义好常用的注释格式,如类、方法、变量等,然后在编写代码时通过快捷键或菜单选项快速插入,大大节省了手动输入的时间。 以下是修改MyEclipse注释模板的步骤: 1. **启动...

    myeclipse简单注释模板

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

    MyEclipse注释模板文件

    为MyEclipse添加注释模板(定制代码注释格式)

    MyEclipse2017注释模板配置文件

    myeclipse2017ci10代码注释优化配置,直接导入即可,轻松配置

    MyEclipse注释模板

    MyEclipse的注释模板允许开发者自定义各种类型的注释格式,如类注释、方法注释、变量注释等。这些模板可以快速插入到代码中,减少手动输入的时间,同时保证注释的一致性和完整性。通过设置个人化的模板,你可以快速...

    MyEclipse配置注释风格

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

    eclipse、myeclipse代码注释模板

    这是一个通用的eclipse代码注释目标,排版非常的整齐,

    Myeclipse多行注释快捷键

    本文将详细介绍MyEclipse中的多行注释快捷键以及其他与代码编辑、格式化、查找替换等相关的快捷键,帮助开发者更加高效地进行编程工作。 #### 多行注释快捷键 在MyEclipse中,对于多行代码的注释,有以下几种常用...

    如何修改MyEclipse方法注释

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

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

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

    eclipse\myeclipse自动配置注释

    对于程序员,刚开始还会写一点注释,后来熟悉了,思路长了,会很容易忘记注释,会很反感写注释,这个文档会教您如何自动配置注释,在每次写方法,写类的时候,eclipse\myeclipse会自动帮您增加注释,希望您会喜欢。

Global site tag (gtag.js) - Google Analytics