`

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 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>  
分享到:
评论

相关推荐

    Eclipse注释模板和格式化模板.zip

    本资料包“Eclipse注释模板和格式化模板.zip”包含了配置这两个功能所需的文件。 首先,我们来看看`codeFormatter.xml`文件。这个文件存储了Eclipse的代码格式化规则。通过定制这些规则,你可以使你的代码遵循特定...

    eclipse注释模板.xml

    eclipse注释模板

    eclipse注释模板文件

    eclipse注释模板文件

    Eclipse注释模板自定义

    一、Eclipse注释模板自定义 1. **打开Eclipse注释模板设置** 要自定义注释模板,首先需要进入Eclipse的首选项设置。点击菜单栏上的“Window” -&gt; “Preferences”,然后在弹出的对话框中依次选择“Java” -&gt; ...

    公司用的eclipse注释模板codetemplates

    公司用的eclipse注释模板codetemplates,经过多次升级最终版本

    eclipse 注释模板

    自定义的一个Eclipse注释模板,codetemplates.xml文件,导入Eclipse即可。我用的Eclipse版本为: Eclipse Java EE IDE for Web Developers. Version: Indigo Service Release 2 + 汉化插件。

    eclipse 注释模板.xml

    eclipse 注释模板.xml

    eclipse注释模板xml文件

    在Eclipse中,开发者可以通过自定义注释模板来快速插入预先定义好的注释结构,这对于代码规范和团队协作非常有帮助。这些自定义模板通常存储在一个XML文件中,使得它们可以被共享、导入和导出。 在Eclipse中,注释...

    Eclipse 代码注释模板

    在Eclipse中,用户可以自定义代码注释模板,这通常涉及到类、方法、变量等不同类型的注释结构。`codetemplates.xml`文件就是存储这些自定义模板的配置文件,通过编辑这个文件,我们可以定制符合个人或团队编码规范的...

    eclipse注释模板及导入

    ### Eclipse注释模板详解与导入方法 在软件开发过程中,良好的代码注释习惯不仅能够提升代码的可读性,还能方便后期的维护和重构。Eclipse作为一款广泛使用的集成开发环境(IDE),提供了丰富的功能来支持开发者的...

    Eclipse Java 注释模板

    Eclipse作为一款强大的Java集成开发环境(IDE),提供了许多便捷的功能,其中之一就是“Eclipse Java 注释模板”。通过配置和使用这些模板,程序员可以快速地为代码添加注释,提高代码的可读性和维护性。下面我们将...

    eclipse注释模板.xml + 修改模板方法 + 使用方法

    一、Eclipse注释模板 Eclipse的注释模板允许程序员快速插入预定义的注释结构,例如类、方法或变量的注释,而无需手动输入每一行。这不仅节省时间,而且有助于保持团队间的一致性和代码文档的完整性。注释模板是通过...

    Myeclipse/eclipse注释模板一键导入配置

    总结来说,"Myeclipse/eclipse注释模板一键导入配置"是提高开发效率的重要手段,通过导入"配置myeclipse注释模板.txt"和"codetemplates.xml"文件,可以快速地定制和统一团队的代码注释风格,使得代码更易于理解和...

    Eclipse 注释模板

    华为风格 Eclipse 注释模板

    Eclipse Java注释模板.txt

    ### Eclipse Java注释模板知识点详解 #### 一、概述 在进行Java开发的过程中,良好的代码注释习惯不仅能帮助自己快速回顾代码逻辑,还能方便其他开发者理解代码意图,从而提高整个团队的工作效率。Eclipse作为一款...

    eclipse注释模板codetemplates.xml

    自己定义的注释模板,还算比较好用。用法是直接下载文件,在eclipse或myeclipse里面导入(preferences -- code templates -- comments -- import),使用的快捷键是 alt+shift+j,注释就自动加好了。

    eclipse/Myeclipse注释模板

    本文将详细介绍如何在 Eclipse 和 MyEclipse 中设置和使用注释模板,以及如何导入和配置提供的 "eclipse注释模板"。 1. **Eclipse 和 MyEclipse 注释模板** Eclipse 和 MyEclipse 都允许用户创建和管理自己的代码...

Global site tag (gtag.js) - Google Analytics