• Java Code Template


    设置注释模板的入口:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素。

    eclipse中快速写入javadoc的快捷键是 ALT + SHIFT + J

    文件(Files)注释标签:

    /**
    * @Description: ${todo}(用一句话描述该文件做什么)
    * @author ${user}
    * @date ${date}
    * @version V1.0
    */

    类型(Types)注释标签(类的注释):

    /**
    *
    *
    * @author ${user}
    * @date ${date}
    */

    字段(Fields)注释标签:

    /**
    * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
    */

    构造函数(Constructor)标签:

    /**
    * 创建一个新的实例 ${enclosing_type}.
    *
    * ${tags}
    */

    方法(Methods)标签:

    /**
    *
    *
    * ${tags}
    */

    覆盖方法(Overriding Methods)标签:

    /*
    *
    *
    * ${tags}
    */

    代理方法(Delegate Methods)标签:

    /**
    * ${tags}
    * ${see_to_target}
    */

    getter方法标签:

    /**
    * @return ${bare_field_name}
    */

    setter方法标签:

    /**
    * @param ${param} the ${bare_field_name} to set
    */

    要实现上面的注释模板,这需要将下面的配置文件导入就可以了:

    <?xml version="1.0" encoding="UTF-8"?>
    <templates>
        <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">
        /**
        * @Description: ${todo}(用一句话描述该文件做什么)
        * @author ${user}
        * @date ${date}
        * @version V1.0  
        */
        </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">
        /**
        * @Description: ${todo}(这里用一句话描述这个类的作用)
        * @author ${user}
        * @date ${date}
        *
        * ${tags}
        */
        </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">
        /**
        * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
        */
        </template>
        <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="false"
            context="methodcomment_context"
            deleted="false"
            description="Comment for non-overriding methods"
            enabled="true"
            id="org.eclipse.jdt.ui.text.codetemplates.methodcomment"
            name="methodcomment">
        /**
        * @Title: ${enclosing_method}
        * @Description: ${todo}(这里用一句话描述这个方法的作用)
        * @param ${tags}    参数
        * @return ${return_type}    返回类型
        * @throws
        */
        </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">
        /* (非 Javadoc)
        * <p>Title: ${enclosing_method}</p>
        * <p>Description: </p>
        * ${tags}
        * ${see_to_overridden}
        */
        </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="gettercomment_context"
            deleted="false"
            description="Comment for getter method"
            enabled="true"
            id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"
            name="gettercomment">
        /**
        * @return ${bare_field_name}
        */
        </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>
     </templates>
  • 相关阅读:
    对PostgreSQL中bufmgr.c 中 bufs_to_lap的初步理解
    bgwriter 的睡眠时间差异
    对PostgreSQL中bufmgr.c 中 num_to_scan 的初步理解
    对PostgreSQL中bufmgr.c的进一步学习
    PHP 接收长url并重定向
    Request.ServerVariables小结
    Kiss Asp Framework 0.2.0RC Releaseed
    FLV编码、转换、录制、播放方案
    ASP错误信息
    Gzip简介
  • 原文地址:https://www.cnblogs.com/Dylansuns/p/7295986.html
Copyright © 2020-2023  润新知