`
longzhun
  • 浏览: 370148 次
  • 性别: Icon_minigender_1
  • 来自: 北京
社区版块
存档分类
最新评论

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}(用一句话描述这个变量表示什么)
*/
构造函数标签：

/**
* <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="gettercomment_context"
		deleted="false" description="Comment for getter method" enabled="true"
		id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"
		name="gettercomment">
/**  
 * @return the ${bare_field_name} 
 */ 
	</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="constructorcomment_context"
		deleted="false" description="Comment for created constructors"
		enabled="true"
		id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"
		name="constructorcomment">
/** 
 * <p>Title:</p>
 * <p>Description:</p>
 * ${tags}
 */
	</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">
/**
 * @Title: ${file_name}
 * @Package ${package_name} 
 * @Description: ${todo}(用一句话描述该文件做什么) 
 * Copyright: Copyright (c) 2009 
 * Company: pkpm 
 * @author longzhun
 * @date ${date} ${time} 
 * @version 1.0 
 */
	</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">
/** 
 * @ClassName: ${type_name} 
 * @Description:${todo}(这里用一句话描述这个类的作用) 
 * @author longzhun
 * @date ${date} ${time}
 * ${tags} 
 */
	</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">
/**
 * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么) 
 */
	</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">
/** 
 * @Title: ${enclosing_method} 
 * @Description:${todo}(这里用一句话描述这个方法的作用) 
 * @param ${tags} 设定文件
 * @return ${return_type} 返回类型 
 * @throws
 * @date ${date} ${time} 
 */
	</template>
	
	<template autoinsert="false" context="overridecomment_context" 
		deleted="false" description="Comment for overriding methods"
		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="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="newtype_context"
		deleted="false" description="Newly created files" enabled="true"
		id="org.eclipse.jdt.ui.text.codetemplates.newtype" name="newtype">
${filecomment} ${package_declaration} 	
/**  
 * @Title: ${file_name} 
 * @Package ${package_name} 
 * @Description: ${todo}(添加描述) 
 * @author longzhun
 * @date ${date} ${time} 
 * @version V1.0 
 */ 
${typecomment} ${type_declaration}
	</template>
	
	<template autoinsert="true" context="classbody_context" 
		deleted="false" description="Code in new class type bodies" 
		enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.classbody"
		name="classbody">
		
	</template>
	
	<template autoinsert="true" context="interfacebody_context"
		deleted="false" description="Code in new interface type bodies"
		enabled="true"
		id="org.eclipse.jdt.ui.text.codetemplates.interfacebody"
		name="interfacebody">
	
	</template>
	
	<template autoinsert="true" context="enumbody_context"
		deleted="false" description="Code in new enum type bodies" 
		enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.enumbody"
		name="enumbody">
		
	</template>
	
	<template autoinsert="true" context="annotationbody_context" 
		deleted="false" description="Code in new annotation type bodies"
		enabled="true"
		id="org.eclipse.jdt.ui.text.codetemplates.annotationbody"
		name="annotationbody">
		
	</template>
	
	<template autoinsert="true" context="catchblock_context" 
		deleted="false" description="Code in new catch blocks" enabled="true"
		id="org.eclipse.jdt.ui.text.codetemplates.catchblock"
		name="catchblock">
		// ${todo} Auto-generated catch block 
		${exception_var}.printStackTrace();
	</template>
	
	<template autoinsert="true" context="methodbody_context" 
		deleted="false" description="Code in created method stubs" 
		enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodbody" 
		name="methodbody">
		// ${todo} Auto-generated method stub ${body_statement}
		
	</template>
	
	<template autoinsert="true" context="constructorbody_context" 
		deleted="false" description="Code in created constructor stubs"
		enabled="true"
		id="org.eclipse.jdt.ui.text.codetemplates.constructorbody"
		name="constructorbody">
		${body_statement} // ${todo} Auto-generated constructor
		stub 
	</template>
	
	<template autoinsert="true" context="getterbody_context" 
		deleted="false" description="Code in created getters" enabled="true"
		id="org.eclipse.jdt.ui.text.codetemplates.getterbody"
		name="getterbody">
		return ${field}; 
	</template>
	
	<template autoinsert="true" context="setterbody_context"
		deleted="false" description="Code in created setters" enabled="true"
		id="org.eclipse.jdt.ui.text.codetemplates.setterbody"
		name="setterbody">
		${field} = ${param};
	</template>
	
</templates>

  
例子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>

 

 

 

SHIFT+ALT+j

分享到：
| myeclipse优化
评论
发表评论

您还没有登录,请您登录后再发表评论

相关推荐

    eclipse java注释模板

    Eclipse Java注释模板设置详解 Eclipse Java注释模板设置详解 设置注释模板的入口: Window-&gt;Preference-&gt;Java-&gt;Code Style-&gt;Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一...

    Eclipse Java注释模板设置详解以及版权声明

    编辑注释模板的方法：Window-&gt;Preference-&gt;Java-&gt;Code Style-&gt;Code Template 然后展开Comments节点就是所有需设置注释的元素啦。 下载该文件后选择右侧Import导入该文件就创建模板成功了. 可以点击每一个选项根据...

    Eclipse Java注释模板.txt

    #### 三、Eclipse Java注释模板详解 下面将对Eclipse中几种常见的注释模板进行详细说明： ##### 1. 文件注释(File Comment) 文件注释通常位于每个Java文件的开头，用于描述该文件的基本信息。示例如下： ```java...

    Eclipse/MyEclipse Java注释模板设置详解

    这篇详细的教程将深入讲解如何在Eclipse和MyEclipse中设置Java注释模板，以提高开发效率和代码规范性。 一、Eclipse与MyEclipse的区别 Eclipse是一款开源的IDE，而MyEclipse是其商业版本，包含了更多的企业级开发...

    eclipse注释模板及导入

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

    eclipse 注释模板

    **Eclipse 注释模板详解** 1. **创建和管理注释模板** 在Eclipse中，你可以通过`Window` -&gt; `Preferences` -&gt; `Java` -&gt; `Code Style` -&gt; `Code Templates`路径来访问和管理注释模板。这里分为三类：`Comments` -&gt;...

    myeclipse/eclipse设置java文档注释

    为了实现统一的 Java 文档注释风格，我们可以利用 Eclipse 的 Code Templates 功能来自定义注释模板。下面将详细介绍如何在 Eclipse 中配置这些模板： 1. **打开 Code Templates 配置界面** - 打开 Eclipse，依次...

    IDEA 类和方法注释模板设置(Windows版).pdf

    ### IDEA类和方法注释模板设置知识点详解 #### 类注释模板设置 1. **模板作用** 类注释模板的作用是在创建Java类文件时，自动添加标准注释信息，从而规范代码结构，提高代码的可读性和可维护性。 2. **设置流程*...

    eclipse 配置JAVA注释

    Eclipse 配置 Java 注释模板详解 Eclipse 是一个功能强大且广泛使用的集成开发环境（IDE），其中 Java 是其支持的主要编程语言之一。为了提高代码的可读性和可维护性，添加合适的注释是非常重要的。Eclipse 提供了...

    eclipse 与myeclipse 注释规范设置

    最后，在`Code Templates`对话框中选择`Code -&gt; New Java files`，可以设置新建Java文件时的注释模板： ```plaintext ${filecomment} ${package_declaration} /** * @Title: ${file_name} * @Package ${package_...

    eclipse快捷键与模板

    ### Eclipse 快捷键与模板详解 #### 一、引言 在软件开发过程中，工具的熟练使用能够显著提升工作效率。Eclipse作为一款强大的开源Java集成开发环境（IDE），提供了丰富的快捷键和模板功能，帮助开发者高效编写代码...

    Java的注释

    本文将详细介绍几种常见的Java注释方式及其用途，并通过实例展示如何设置Eclipse IDE中的注释模板，帮助开发者更好地管理和组织代码。 #### 一、Java注释概述 Java提供了三种类型的注释： 1. **单行注释（//）**：...

    Eclipse中设置在创建新类时自动生成注释

    ### 设置流程详解 #### 步骤一：进入偏好设置 首先，打开Eclipse，进入“Window”菜单，选择“Preferences”选项。这一步是访问Eclipse所有配置项的入口，通过它，我们可以对编辑器、构建路径、外观等进行个性化...

    eclipse增加getset方法根据字段注释自动生成中文注释功能.docx

    除了修改`GetterSetterUtil`类外，还需要调整Eclipse的注释模板设置，以确保自动生成的注释符合预期。 1. 打开Eclipse，依次点击菜单`Window -&gt; Preferences -&gt; Java -&gt; Code Style -&gt; Code Templates`。 2. 在右侧...

    eclipse自动注释

    其中，“Eclipse自动注释”功能更是为Java开发人员带来了极大的便利，它允许用户自定义模板来快速生成文件头注释或类注释等，从而提高开发效率并保持项目文档的一致性。 #### 二、配置步骤 ##### 1. 打开配置界面 ...

    Eclipse的快捷键以及各个注释的快捷键

    Eclipse快捷键和文档注释设置详解 Eclipse是一款功能强大且广泛使用的集成开发环境（IDE），它提供了许多实用的快捷键来提高开发效率。同时，Eclipse也提供了丰富的文档注释功能，帮助开发者更好地记录和管理代码。...

Magicbox
Global site tag (gtag.js) - Google Analytics