zoukankan      html  css  js  c++  java
  • 设置JAVA注释模板

     

    找到注释模板所在的地方: window à Preference à Java à Code Style à Code Template 然后展开 Comments 节点就是所需要设置注释的元素了:

     

    文件(Files)注释标签:

    /** 

    * @Project: ${project_name}

    * @Title: ${file_name}

    * @Package ${package_name}

    * @Description: ${todo}

    * @authorshenyanghong ahong2011@gmail.com

    * @date ${date} ${time}

    * @Copyright: ${year}

    * @version V1.0 

    */

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

    /**

     * @ClassName ${type_name}

     * @Description ${todo}

     * @authorshenyanghong ahong2011@gmail.com

     * @date ${date}

     * ${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}
    */

    简单模板例1:

    <?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 jeffshaw email:jeff_chon@hotmail.com    
    * @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 jeffshaw email:jeff_chon@hotmail.com  
    * @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:

    <?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: jeffwhaw email:jeff_chon@hotmail.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   CodingExampleVer(编码范例查看) 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: jeffshaw email:jeff_chon@hotmail.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: jeffshaw email:jeff_chon@hotmail.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   CodingExampleVer(编码范例查看) 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: jeffshaw email:jeff_chon@hotmail.com
         * @version: ${date} ${time}
         */
        </template>
    </templates>

  • 相关阅读:
    (转)深入浅出JWT(JSON Web token)
    Node.js Koa2开发微信小程序服务端
    天翼宽带家庭网关用户:useradmin,nE7jA%5m 这个是中国电信的超级密码
    微信小程序picker重写,精确到时分秒
    Vue props中Object和Array设置默认值
    GreenDao学习
    Android注解支持(Support Annotations) (转)
    异常:Error:Execution failed for task ':app:compileDebugJavaWithJavac'. > Compilation failed; see the compiler error output for details.
    精通 Android Data Binding
    Android BroadcastReceiver介绍 (转)
  • 原文地址:https://www.cnblogs.com/lbangel/p/3080123.html
Copyright © 2011-2022 走看看