[Java] Eclipse注释模板设置详解

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

</template>

例子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>

转自：http://blog.csdn.net/ahhsxy/archive/2009/09/11/4542682.aspx

[Java] Eclipse注释模板设置详解的更多相关文章

【转载】 Eclipse注释模板设置详解
Eclipse注释模板设置详解网站推荐: 金丝燕网(主要内容是 Java 相关) 木秀林网(主要内容是消息队列)
Eclipse注释模板设置详解
设置注释模板的入口:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素 ...
【转】Eclipse Java注释模板设置详解
Eclipse Java注释模板设置详解设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后 ...
Eclipse Java注释模板设置详解以及版权声明
网上的Eclipse注释模板,在这里稍稍整理一些比较常用的. 编辑注释模板的方法:Window->Preference->Java->Code Style->Code Temp ...
"佛祖保佑永无bug" 注释模板设置详解(仅供娱乐)
1.注释模板效果图今天在网上看到一段有趣的注释,佛祖保佑永无bug, 效果如下图所示: 代码如下所示: /** * _ooOoo_ * o8888888o * 88" . " ...
Android Studio "佛祖保佑永无bug" 注释模板设置详解(仅供娱乐)
1.注释模板效果图今天在网上看到一段有趣的注释,佛祖保佑永无bug, 效果如下图所示: 代码如下所示: /** * _ooOoo_ * o8888888o * 88" . "8 ...
Eclipse Java注释模板设置详解
设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元 ...
Eclipse Java注释模板设置详解，更改 ${user}和${date}
修改MyEclipse eclipse 注释的作者名字转自:http://www.oschina.net/question/158170_31311 在eclipse/myeclipse中,当我们去 ...
[转]Eclipse Java注释模板设置详解
原文链接:http://blog.csdn.net/ahhsxy/archive/2009/09/11/4542682.aspx 设置注释模板的入口: Window->Preference-&g ...

随机推荐

JS代码格式化修改表格的数值的格式
今天在cognos中第一次需要用到JS,主要是报表页面展示的时候是可能得到如下的数据 ,我需要对其中类型中有金额字样的,后面的数值,精确2位小数:有百分比字样的,数值显示成百分比.如下. 我先尝试了自 ...
HDU 5776 sum （模拟）
sum 题目链接: http://acm.hdu.edu.cn/showproblem.php?pid=5776 Description Given a sequence, you're asked ...
Spring InitializingBean and DisposableBean example
In Spring, InitializingBean and DisposableBean are two marker interfaces, a useful way for Spring to ...
hdu 4763 Theme Section(KMP水题)
Theme Section Time Limit: 2000/1000 MS (Java/Others) Memory Limit: 32768/32768 K (Java/Others) To ...
Spring REST实践之HATEOAS
HATEOAS HATEOAS(The Hypermedia As The Engine Of Application Statue)是REST架构的主要约束."hepermedia&quo ...
C#学习笔记（十二）：正则表达式
Regex 正则表达式的类,我们可以通过该类来使用正则表达式. 比如下面我们使用Regex来判断输入的字符串是否符合指定的格式: using System; using System.Text.Reg ...
DataGridView 添加ComboBox
http://www.wapsolo.com/Personal/personal_view_75.aspx DataGridView 添加ComboBox 第一: 先在窗体设计时拖一个ComBoBox ...
Hadoop本地库
目的鉴于性能问题以及某些Java类库的缺失,对于某些组件,Hadoop提供了自己的本地实现. 这些组件保存在Hadoop的一个独立的动态链接的库里.这个库在*nix平台上叫libhadoop.so. ...
ALT(预警)
1. Alert简介 Alert是一种Oracle系统中的一种机制,它可以监视系统数据库,在规定的情况下给规定用户一个通知,通知可以是邮件或者其他形式,在标注的系统和客户化系统中都是可以定义使用的 2 ...
Node.js和mybatis分别实现mysql中like变量模糊查询
 <where> <if test="varName != '' and varName != null" > ...

[Java] Eclipse注释模板设置详解

[Java] Eclipse注释模板设置详解的更多相关文章

随机推荐

热门专题