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

来源：百度文库 编辑：偶看新闻 时间：2024/07/06 19:26:04

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:


* ${tags}
*/


方法(Constructor & Methods)标签：

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


覆盖方法(Overriding Methods)标签：

/* (非 Javadoc)
*

Title: ${enclosing_method}


*

Description:


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


代表方法(Delegate Methods)标签：

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

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

setter方法标签：

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

简单模板例子：

Xml代码
  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代码 
     
  1.  version="1.0" encoding="UTF-8"?>     
    2.  
  2.      
    3.  
  3.           
    4.  
  4.            
    5.  
  5.                 autoinsert="false"       
    6.  
  6.                 context="constructorcomment_context"       
    7.  
  7.                 deleted="false"       
    8.  
  8.                 description="Comment for created constructors"       
    9.  
  9.                 enabled="true"       
    10.  
  10.                 id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"     
    11.  
  11.                 name="constructorcomment">     
    12.  
  12.     /**      
    13.  
  13.      * 创建一个新的实例 ${enclosing_type}.      
    14.  
  14.      *      
    15.  
  15.      * ${tags}      
    16.  
  16.      */      
    17.  
  17.          
    18.  
  18.           
    19.  
  19.            
    20.  
  20.                 autoinsert="true"       
    21.  
  21.                 context="settercomment_context"     
    22.  
  22.                 deleted="false"       
    23.  
  23.                 description="Comment for setter method"       
    24.  
  24.                 enabled="true"       
    25.  
  25.                 id="org.eclipse.jdt.ui.text.codetemplates.settercomment"       
    26.  
  26.                 name="settercomment">     
    27.  
  27.     /**      
    28.  
  28.      * @param ${param} the ${bare_field_name} to set      
    29.  
  29.      */      
    30.  
  30.          
    31.  
  31.           
    32.  
  32.           
    33.  
  33.          
    34.  
  34.                 autoinsert="false"       
    35.  
  35.                 context="methodcomment_context"       
    36.  
  36.                 deleted="false"       
    37.  
  37.                 description="Comment for non-overriding methods"       
    38.  
  38.                 enabled="true"       
    39.  
  39.                 id="org.eclipse.jdt.ui.text.codetemplates.methodcomment"       
    40.  
  40.                 name="methodcomment">     
    41.  
  41.     /**      
    42.  
  42.      * 此方法描述的是：      
    43.  
  43.      * @author: wangxiongdx@163.com      
    44.  
  44.      * @version: ${date} ${time}      
    45.  
  45.      */      
    46.  
  46.          
    47.  
  47.           
    48.  
  48.           
    49.  
  49.            
    50.  
  50.                 autoinsert="true"       
    51.  
  51.                 context="delegatecomment_context"       
    52.  
  52.                 deleted="false"       
    53.  
  53.                 description="Comment for delegate methods"       
    54.  
  54.                 enabled="true"       
    55.  
  55.                 id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment"       
    56.  
  56.                 name="delegatecomment">     
    57.  
  57.     /**      
    58.  
  58.      * ${tags}      
    59.  
  59.      * ${see_to_target}      
    60.  
  60.      */      
    61.  
  61.          
    62.  
  62.           
    63.  
  63.           
    64.  
  64.          
    65.  
  65.                 autoinsert="false"       
    66.  
  66.                 context="filecomment_context"       
    67.  
  67.                 deleted="false"       
    68.  
  68.                 description="Comment for created Java files"       
    69.  
  69.                 enabled="true"       
    70.  
  70.                 id="org.eclipse.jdt.ui.text.codetemplates.filecomment"       
    71.  
  71.                 name="filecomment">     
    72.  
  72.     /**      
    73.  
  73.      * 文件名：${file_name}      
    74.  
  74.      *      
    75.  
  75.      * 版本信息：      
    76.  
  76.      * 日期：${date}      
    77.  
  77.      * Copyright 足下 Corporation ${year}       
    78.  
  78.      * 版权所有      
    79.  
  79.      *      
    80.  
  80.      */      
    81.  
  81.          
    82.  
  82.           
    83.  
  83.           
    84.  
  84.            
    85.  
  85.                 autoinsert="false"       
    86.  
  86.                 context="gettercomment_context"       
    87.  
  87.                 deleted="false"       
    88.  
  88.                 description="Comment for getter method"       
    89.  
  89.                 enabled="true"       
    90.  
  90.                 id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"       
    91.  
  91.                 name="gettercomment">     
    92.  
  92.     /**      
    93.  
  93.      * ${bare_field_name}      
    94.  
  94.      *      
    95.  
  95.      * @return  the ${bare_field_name}      
    96.  
  96.      * @since   CodingExample Ver(编码范例查看) 1.0      
    97.  
  97.     */      
    98.  
  98.          
    99.  
  99.      
    100.  
  100.            
    101.  
  101.                 autoinsert="true"       
    102.  
  102.                 context="overridecomment_context"       
    103.  
  103.                 deleted="false"       
    104.  
  104.                 description="Comment for overriding methods"       
    105.  
  105.                 enabled="true"       
    106.  
  106.                 id="org.eclipse.jdt.ui.text.codetemplates.overridecomment"       
    107.  
  107.                 name="overridecomment">     
    108.  
  108.     /* (non-Javadoc)      
    109.  
  109.      * ${see_to_overridden}      
    110.  
  110.      */      
    111.  
  111.          
    112.  
  112.           
    113.  
  113.           
    114.  
  114.            
    115.  
  115.                 autoinsert="false"       
    116.  
  116.                 context="fieldcomment_context"       
    117.  
  117.                 deleted="false"       
    118.  
  118.                 description="Comment for fields"       
    119.  
  119.                 enabled="true"       
    120.  
  120.                 id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment"       
    121.  
  121.                 name="fieldcomment">     
    122.  
  122.     /**      
    123.  
  123.      * ${field}:${todo}（用一句话描述这个变量表示什么）      
    124.  
  124.      *      
    125.  
  125.      * @since Ver 1.1      
    126.  
  126.      */      
    127.  
  127.          
    128.  
  128.           
    129.  
  129.           
    130.  
  130.            
    131.  
  131.                 autoinsert="false"       
    132.  
  132.                 context="typecomment_context"       
    133.  
  133.                 deleted="false"       
    134.  
  134.                 description="Comment for created types"       
    135.  
  135.                 enabled="true"       
    136.  
  136.                 id="org.eclipse.jdt.ui.text.codetemplates.typecomment"       
    137.  
  137.                 name="typecomment">     
    138.  
  138.     /**      
    139.  
  139.      * 此类描述的是：      
    140.  
  140.      * @author: wangxiongdx@163.com      
    141.  
  141.      * @version: ${date} ${time}       
    142.  
  142.      */      
    143.  
  143.          
    144.  
  144.        
    145.  
  145.      
/*** 创建一个新的实例 ${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
请问JAVA eclipse需要如何设置才能运行java程序 《离骚》全文、注释、详解 用Eclipse做JAVA JAVA程序的注释 java 与 eclipse 的问题 eclipse中java文件问题 模板设置 eclipse的debug怎么设置 eclipse如何设置编译参数？ 在eclipse中设置gui 做JAVA程序，用 Eclipse 还是 JBuilder eclipse 3支持什么版本的JAVA 关于eclipse编写java application的问题 BIOS设置详解图 Phoenix BIOS设置详解 怎样设置关机注释呢 提供Java小程序，加注释 如何设置eclipse的输入快捷方式 关于ECLIPSE中J2ME的设置问题？ 如何设置网页模板？ 在哪能找到JAVA中的函数详解 如何将JSP+JAVA 源码在ECLIPSE中打开? 哪里可以找到eclipse的 可视化java编程插件? java 学习Swing eclipse有什么好的插件吗？