zoukankan      html  css  js  c++  java
  • eclipse注释模板

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

    1、用红色圈出来的是需要 注释 的项

    2、编辑

    本作者,此次主要是 用到Types

    /**  
    * @ClassName: ${type_name}  
    * @Description: ${todo}(这里用一句话描述这个类的作用)  
    * @author ${user}  
    * @date ${date}  
    *  
    * ${tags}  
    */  

     3、实现效果

    /**
     * 
    * @ClassName: XXXServiceImpl  
    * @Description: TODO(这里用一句话描述这个类的作用)  
    * @author unisk1805  
    * @date 2018年6月27日  
    *
     */

    本文参考自 :https://blog.csdn.net/paul342/article/details/52982585

    详情如下:

    设置注释模板的入口:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素。本文现就每一个元素逐一给大家介绍一下。

    文件(Files)注释标签:

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

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

    /**  
    * @ClassName: ${type_name}  
    * @Description: ${todo}(这里用一句话描述这个类的作用)  
    * @author ${user}  
    * @date ${date}  
    *  
    * ${tags}  
    */  

    字段(Fields)注释标签:

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

    构造函数(Constructor)标签:

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

    方法(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 paramtheparamthe{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">  
        /**    
        * @Title: ${file_name}  
        * @Package ${package_name}  
        * @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">  
        /**  
        * @ClassName: ${type_name}  
        * @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: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 paramtheparamthe{bare_field_name} to set  
         */  
        </template>  
    </templates>  
  • 相关阅读:
    sql分页存储过程疑惑:Row_Number与临时表哪个好?
    SQL之剪切
    在sqlserver2005中安装sql server 2000的示例数据库northwind
    安装SQL2005示例数据库
    Firefox浏览器中,Flex的FileReference上传文件,引发IOError
    Java获取方法的调用者
    ABAP screen常见语法
    XPO永久删除记录方法
    XPO的UpCasting
    在ASP.NET项目中使用XPO的最佳准则
  • 原文地址:https://www.cnblogs.com/xiaonantianmen/p/9232915.html
Copyright © 2011-2022 走看看