<?xml version="1.0" encoding="UTF-8"?>  "/>

在Eclipse下面使用注释模板自动生成说明

Posted

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了在Eclipse下面使用注释模板自动生成说明相关的知识,希望对你有一定的参考价值。

Xml代码  技术分享

  1. <?xml version="1.0" encoding="UTF-8"?>  

  2. <templates>  

  3.     <template autoinsert="true" context="filecomment_context"  

  4.         deleted="false" description="已创建的 Java 文件的注释" enabled="true"  

  5.         id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">  

  6.     /**  

  7.      * @Project     ${project_name}  

  8.      * @File        ${file_name}  

  9.      * @Package     ${package_name}  

  10.      * @Version     V1.0  

  11.      * @Date        ${date} ${time}  

  12.      * @Author      张三  

  13.      * Copyright (c) All Rights Reserved, ${year}.  

  14.      */  

  15.     </template>  

  16.     <template autoinsert="true" context="typecomment_context"  

  17.         deleted="false" description="创建的类型的注释" enabled="true"  

  18.         id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">  

  19.     /**  

  20.      * @Description ${todo}  

  21.      * @ClassName   ${type_name}  

  22.      * @Date        ${date} ${time}  

  23.      * @Author      张三  

  24.      * Copyright (c) All Rights Reserved, ${year}.  

  25.      */  

  26.     </template>  

  27.     <template autoinsert="true" context="fieldcomment_context"  

  28.         deleted="false" description="字段的注释" enabled="true"  

  29.         id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">  

  30.     /**  

  31.      * @Description ${todo}  

  32.      * @Author      张三  

  33.      * @Date        ${date} ${time}  

  34.      * @Fields ${field} ${todo}  

  35.      */  

  36.     </template>  

  37.     <template autoinsert="true" context="methodcomment_context"  

  38.         deleted="false" description="非覆盖方法的注释" enabled="true"  

  39.         id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">  

  40.     /**  

  41.      * @Description ${todo}  

  42.      * @Author      张三  

  43.      * @Date        ${date} ${time}  

  44.      * @param ${tags} 参数  

  45.      * @return ${return_type} 返回类型   

  46.      * @throws  

  47.      */  

  48.     </template>  

  49.     <template autoinsert="true" context="delegatecomment_context"  

  50.         deleted="false" description="代表方法的注释" enabled="true"  

  51.         id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">  

  52.     /**  

  53.      * @Description ${todo}  

  54.      * @Author      张三  

  55.      * @Date        ${date} ${time}  

  56.      * ${tags}  

  57.      * ${see_to_target}  

  58.      */  

  59.     </template>  

  60.    

  61.     <template autoinsert="true" context="gettercomment_context"  

  62.         deleted="false" description="getter 方法的注释" enabled="true"  

  63.         id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">  

  64.     /**  

  65.      * @Description ${todo}  

  66.      * @Author      张三  

  67.      * @Date        ${date} ${time}  

  68.      * @return ${bare_field_name}  

  69.      */  

  70.     </template>  

  71.     <template autoinsert="true" context="settercomment_context"  

  72.         deleted="false" description="setter 方法的注释" enabled="true"  

  73.         id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">  

  74.     /**  

  75.      * @Description ${todo}  

  76.      * @Author      张三  

  77.      * @Date        ${date} ${time}  

  78.      * @param ${param} ${bare_field_name}  

  79.      */  

  80.     </template>  

  81.     <template autoinsert="true" context="overridecomment_context"  

  82.         deleted="false" description="覆盖方法的注释" enabled="true"  

  83.         id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">  

  84.     /**  

  85.      * @Description ${todo}  

  86.      * @Author      张三  

  87.      * @Date        ${date} ${time}  

  88.      * @param ${tags} 参数  

  89.      * @return ${return_type} 返回类型   

  90.      * @throws  

  91.      */  

  92.     </template>  

  93. </templates>  

 

 

 第一种:文件导入  下载

 

    使用方式:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素

 

 

 

第二种:直接找到相应的JAVA / JSP /JS等文件进行手动敲上备注。下载

 

    使用方式:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素

 

如:

/**

* @Project${project_name}

* @File${file_name}

* @Package${package_name}

* @VersionV1.0

* @Date${date} ${time}

* @Author张三

* Copyright (c) All Rights Reserved, ${year}.

*/

 


技术分享


以上是关于在Eclipse下面使用注释模板自动生成说明的主要内容,如果未能解决你的问题,请参考以下文章

如何在eclipse 中设置自动添加Javadoc注释

eclipse各种注释如何自动添加

Eclipse给方法或者类添加自动注释

如何在eclipse 中设置自动添加Javadoc注释

禁用Eclipse中的自动注释生成

的上面自动添加代码注释,Eclipse中该怎么设置