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

    </templates>  
    <?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: 
    <?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> 

     或者:
     
    1. <?xml version="1.0" encoding="UTF-8"?>  
    2. <templates>  
    3.   
    4. <template autoinsert="false"  
    5.                  context="constructorcomment_context"  
    6.                  deleted="false" description="Comment for created constructors"  
    7.                  enabled="true"  
    8.                  id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"  
    9.                  name="constructorcomment">   
    10. /**    
    11. * 创建一个新的实例 ${enclosing_type}.    
    12. *    
    13. * ${tags}    
    14. */  
    15. </template>  
    16.   
    17. <template autoinsert="true"  
    18.                  context="settercomment_context"  
    19.                  deleted="false"  
    20.                  description="Comment for setter method"  
    21.                  enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment"  
    22.                  name="settercomment">  
    23. /**    
    24. * @param ${param} the ${bare_field_name} to set    
    25. */  
    26. </template>  
    27.   
    28. <template autoinsert="false"  
    29.                  context="methodcomment_context"  
    30.                  deleted="false"  
    31.                  description="Comment for non-overriding methods"  
    32.                  enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment"  
    33.                  name="methodcomment">  
    34. /**    
    35.    
    36. * ${enclosing_method}(这里用一句话描述这个方法的作用)    
    37.    
    38. * TODO(这里描述这个方法适用条件 – 可选)    
    39.    
    40. * TODO(这里描述这个方法的执行流程 – 可选)    
    41.    
    42. * TODO(这里描述这个方法的使用方法 – 可选)    
    43.    
    44. * TODO(这里描述这个方法的注意事项 – 可选)    
    45.    
    46. * @param   name    
    47.    
    48. * @param  @return    设定文件    
    49.    
    50. * @return String    DOM对象    
    51.    
    52. * @Exception 异常对象    
    53.    
    54. * @since  CodingExample Ver(编码范例查看) 1.1    
    55.    
    56. */  
    57. </template>  
    58.   
    59. <template autoinsert="true"  
    60.                  context="delegatecomment_context"  
    61.                  deleted="false"  
    62.                  description="Comment for delegate methods"  
    63.                  enabled="true"  
    64.                  id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment"  
    65.                  name="delegatecomment">  
    66. /**    
    67. * ${tags}    
    68. * ${see_to_target}    
    69. */  
    70. </template>  
    71.   
    72. <template autoinsert="false"  
    73.                  context="filecomment_context"  
    74.                  deleted="false"  
    75.                  description="Comment for created Java files"  
    76.                  enabled="true"  
    77.                  id="org.eclipse.jdt.ui.text.codetemplates.filecomment"  
    78.                  name="filecomment">  
    79. /**    
    80. * 文件名:${file_name}    
    81. *    
    82. * 版本信息:    
    83. * 日期:${date}    
    84. * Copyright 足下 Corporation ${year}     
    85. * 版权所有    
    86. *    
    87. */  
    88. </template>  
    89.   
    90. <template autoinsert="false"  
    91.                  context="gettercomment_context"  
    92.                  deleted="false"  
    93.                  description="Comment for getter method"  
    94.                  enabled="true"  
    95.                  id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"  
    96.                  name="gettercomment">  
    97. /**    
    98. * ${bare_field_name}    
    99. *    
    100. * @return  the ${bare_field_name}    
    101. * @since   CodingExample Ver(编码范例查看) 1.0    
    102. */    
    103. </template>  
    104.   
    105. <template autoinsert="true"  
    106.                  context="overridecomment_context"  
    107.                  deleted="false"  
    108.                  description="Comment for overriding methods"  
    109.                  enabled="true"  
    110.                  id="org.eclipse.jdt.ui.text.codetemplates.overridecomment"  
    111.                  name="overridecomment">  
    112. /**  
    113. * (non-Javadoc)    
    114. * ${see_to_overridden}    
    115. */  
    116. </template>  
    117.   
    118. <template autoinsert="false"  
    119.                  context="fieldcomment_context"  
    120.                  deleted="false"  
    121.                  description="Comment for fields"  
    122.                  enabled="true"  
    123.                  id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment"  
    124.                  name="fieldcomment">  
    125. /**    
    126. * ${field}:${todo}(用一句话描述这个变量表示什么)    
    127. *    
    128. * @since Ver 1.1    
    129. */    
    130. </template>  
    131.   
    132. <template autoinsert="false"  
    133.                  context="typecomment_context"  
    134.                  deleted="false"  
    135.                  description="Comment for created types"  
    136.                  enabled="true"  
    137.                  id="org.eclipse.jdt.ui.text.codetemplates.typecomment"  
    138.                  name="typecomment">  
    139. /**    
    140. *     
    141. * 项目名称:${project_name}    
    142. * 类名称:${type_name}    
    143. * 类描述:    
    144. * 创建人:${user}    
    145. * 创建时间:${date} ${time}    
    146. * 修改人:${user}    
    147. * 修改时间:${date} ${time}    
    148. * 修改备注:    
    149. * @version     
    150. *     
    151. */</template>  
    152.   
    153. </templates>