圣空法师最新消息:Eclipse Java注释模板设置详解 - 甘蔗的小本子 - JavaEye技术网站

Eclipse Java注释模板设置详解

设置注释模板的入口： 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}(用一句话描述这个变量表示什么)
*/
构造函数标签：

/**
*

Title:

Description:

方法(Constructor & Methods)标签：

/**
* @Title: ${enclosing_method}
* @Description: ${todo}(这里用一句话描述这个方法的作用)
* @param ${tags}    设定文件
* @return ${return_type}    返回类型
* @throws
*/

覆盖方法(Overriding Methods)标签：

/* (非 Javadoc)
*

Title: ${enclosing_method}

Description:

代表方法(Delegate Methods)标签：

/**
* ${tags}
* ${see_to_target}
*/
getter方法标签：

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

setter方法标签：

/**
* @param ${param} 要设置的 ${bare_field_name}
*/

简单模板例子：

1. view plaincopy to clipboardprint?   
2.  version="1.0" encoding="UTF-8"?> autoinsert="true" context="fieldcomment_context" deleted="false" description="字段的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/**     
3. * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)     
4. */     
5.  autoinsert="true" context="gettercomment_context" deleted="false" description="getter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/**     
6.  * @return ${bare_field_name}     
7.  */     
8.   autoinsert="true" context="constructorcomment_context" deleted="false" description="创建的构造函数的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/**     
9. * 

   Title:${file_name} 

        
10. * 

    Description: 构造函数

         
11. * ${tags}     
12. */     
13.  autoinsert="true" context="filecomment_context" deleted="false" description="已创建的 Java 文件的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/**       
14. * @Title: ${file_name}     
15. * @Package ${package_name}     
16. * @Description: ${todo}(用一句话描述该文件做什么)     
17. * @author DAIGUANGJIU        
18. * @date ${date} ${time}     
19. * @version V1.0       
20. */     
21.   autoinsert="true" context="settercomment_context" deleted="false" description="setter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/**     
22.  * @param ${param} 要设置的 ${bare_field_name}     
23.  */ autoinsert="true" context="typecomment_context" deleted="false" description="创建的类型的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/**     
24.  * @author ${user}     
25.  *     
26.  * ${tags}     
27.  */ autoinsert="true" context="delegatecomment_context" deleted="false" description="代表方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/**     
28. * ${tags}     
29. * ${see_to_target}     
30. */ autoinsert="true" context="overridecomment_context" deleted="false" description="覆盖方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">/** (非 Javadoc)     
31. * 

    Title: ${enclosing_method}

         
32. * 

    Description: 

         
33. * ${tags}     
34. * ${see_to_overridden}     
35. */ autoinsert="true" context="methodcomment_context" deleted="false" description="非覆盖方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/**     
36.  * ${tags}     
37.  */     
38.  version="1.0" encoding="UTF-8"?> autoinsert="true" context="fieldcomment_context" deleted="false" description="字段的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/**   
39. * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)   
40. */   
41.  autoinsert="true" context="gettercomment_context" deleted="false" description="getter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/**   
42.  * @return ${bare_field_name}   
43.  */   
44.   autoinsert="true" context="constructorcomment_context" deleted="false" description="创建的构造函数的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/**   
45. * 

    Title:${file_name} 

      
46. * 

    Description: 构造函数

      
47. * ${tags}   
48. */   
49.  autoinsert="true" context="filecomment_context" deleted="false" description="已创建的 Java 文件的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/**     
50. * @Title: ${file_name}   
51. * @Package ${package_name}   
52. * @Description: ${todo}(用一句话描述该文件做什么)   
53. * @author DAIGUANGJIU      
54. * @date ${date} ${time}   
55. * @version V1.0     
56. */   
57.   autoinsert="true" context="settercomment_context" deleted="false" description="setter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/**   
58.  * @param ${param} 要设置的 ${bare_field_name}   
59.  */ autoinsert="true" context="typecomment_context" deleted="false" description="创建的类型的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/**   
60.  * @author ${user}   
61.  *   
62.  * ${tags}   
63.  */ autoinsert="true" context="delegatecomment_context" deleted="false" description="代表方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/**   
64. * ${tags}   
65. * ${see_to_target}   
66. */ autoinsert="true" context="overridecomment_context" deleted="false" description="覆盖方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">/** (非 Javadoc)   
67. * 

    Title: ${enclosing_method}

      
68. * 

    Description: 

      
69. * ${tags}   
70. * ${see_to_overridden}   
71. */ autoinsert="true" context="methodcomment_context" deleted="false" description="非覆盖方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/**   
72.  * ${tags}   
73.  */   

view plaincopy to clipboardprint?
 
例子2：
view plaincopy to clipboardprint?
Xml代码 
 
 version="1.0" encoding="UTF-8"?>     
 
     
 
          
 
           
 
                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}      
 
     */      
 
         
 
          
 
           
 
                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      
 
     */      
 
         
 
          
 
          
 
         
 
                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}      
 
     */      
 
         
 
          
 
          
 
           
 
                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}      
 
     */      
 
         
 
          
 
          
 
         
 
                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}       
 
     * 版权所有      
 
     *      
 
     */      
 
         
 
          
 
          
 
           
 
                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      
 
    */      
 
         
 
     
 
           
 
                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}      
 
     */      
 
         
 
          
 
          
 
           
 
                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      
 
     */      
 
         
 
          
 
          
 
           
 
                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}       
 
     */      
 
         
 
       
 
     
/*** 创建一个新的实例 ${enclosing_type}.** ${tags}*//*** @param ${param} the ${bare_field_name} to set*//*** 此方法描述的是：* @author: wangxiongdx@163.com* @version: ${date} ${time}*//*** ${tags}* ${see_to_target}*//*** 文件名：${file_name}** 版本信息：* 日期：${date}* Copyright 足下 Corporation ${year}* 版权所有**//*** ${bare_field_name}** @return  the ${bare_field_name}* @since   CodingExample Ver(编码范例查看) 1.0*//* (non-Javadoc)* ${see_to_overridden}*//*** ${field}:${todo}（用一句话描述这个变量表示什么）** @since Ver 1.1*//*** 此类描述的是：* @author: wangxiongdx@163.com* @version: ${date} ${time}*/  
 

本文来自CSDN博客，转载请标明出处：http://blog.csdn.net/ahhsxy/archive/2009/09/11/4542682.aspx