Eclipse Java注释模板设置详解

最新推荐文章于 2021-02-12 15:14:51 发布
最新推荐文章于 2021-02-12 15:14:51 发布
阅读量108 收藏
点赞数
分类专栏： eclipse插件 文章标签： java 开发工具 ui
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/a414129902/article/details/83974220
版权

设置注释模板的入口： 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

Eclipse Code Templates设置
weixin_34395205的博客
07-20 368
从工作开始，经历了几个项目的开发，现在的项目一般都是一个团队共同开发，而每个人都有自己的编码习惯，为了统一格式，项目组在项目开发之前都会制定一系列的规范。俗话说约定优于配置，但是在执行过程中往往发现效果不是很好（主要是指编码规范这一方面）。所以我们不得不采取一些措施来协助我们统一项目开发人员的编码风格。主要包括三个方面：设置Code Templates、Eclipse formatter、Chec...
Eclipse注释模板设置详解
wqy_zyc的博客
05-16 1269
Java开发Eclipse注解解释: @基础字段属性 ${bare_field_name} @日期2018年5月16日 ${date} @美元符号$ $$ @封闭方法 ${enclosing_method} @封闭类型 ${enclosing_type} @值 ${field} @值类型 ${field_type} @文件名 ${file_name} @ ...
Eclipse代码注释模板——code templates
热门推荐
security08的专栏
05-13 3万+
操作步骤:打开Window->Preferences->Java->Code Style->Code Templates如图：  点击“Import”，导入模板codetemplates.xml文件。 附：codetemplates.xml文件内容/** * 项目名：系统项目名称 * 包名：${package_name} * 文件名：${file_n
利用Eclipse自动生成comments（注释）
微信号codek2 专注于 Android 开源项目源码解析 开源项目分享
03-08 1706
可以方便的利用Eclipse生成注释，对于已经添加过的注释可以方便的修改 下面的blog中说明了如何修改comments（注释）中的author，其他信息可以类似修改或添加 blog地址：http://icansoft.blog.51cto.com/268543/55871、 刚看见个新闻补充下：http://java.csdn.net/a/20100308/259219.
Eclipse Java注释模板设置详解以及版权声明
03-29
编辑注释模板的方法：Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。 下载该文件后选择右侧Import导入该文件就创建模板成功了. 可以点击每一个选项根据...
Eclipse Java注释模板.txt
07-09
#### 三、Eclipse Java注释模板详解 下面将对Eclipse中几种常见的注释模板进行详细说明： ##### 1. 文件注释(File Comment) 文件注释通常位于每个Java文件的开头，用于描述该文件的基本信息。示例如下： ```java...
Eclipse/MyEclipse Java注释模板设置详解
03-30
这篇详细的教程将深入讲解如何在Eclipse和MyEclipse中设置Java注释模板，以提高开发效率和代码规范性。 一、Eclipse与MyEclipse的区别 Eclipse是一款开源的IDE，而MyEclipse是其商业版本，包含了更多的企业级开发...
Eclipse 配置之Java代码模板
BerMaker
08-06 4310
Eclipse 配置之Java代码模板Eclipse 配置之Java代码模板 Java 代码模板 Comments 设置 Java 代码模板点击 Eclipse Preferences -> Java -> Code Style -> Code Templates, 有Comments和Code两项设置：Comments 设置 Files /** * @Title: ${file_name} *
eclipse 修改类的注释
dawn的专栏
10-22 376
windows–>preference Java–>Code Style–>Code Templates code–>new Java files 编辑它 ${filecomment} ${package_declaration} /** * @author 作者 E-mail: * @version 创建时间：${date} ${time} * 类说明 */ ${typ
Eclipse常用设置
阿杜
12-10 1万+
1、新建Java文件时的自动头信息注释设置： Windows->Preferences->java->code style->code Templates->code->New Java Files 双击此选项，修改内容如下： ${filecomment} ${package_declaration} /**  * @Author: duke  * @Date: ${date
Eclipse---设置代码模板（注释信息、作者信息）
魔芋小灰菜
05-12 1663
Eclipse—设置代码模板（注释信息） 路径：Window->Preferences->Java->Code Style->Code Templates 展开Code->New Java files ,此时在pattern中展示的模板便是在eclipse中新建 java类使用的模板 关于author的设置： 1.在Eclipse启动时加入启动参数或在eclipse.ini中 -vmargs 后面增加参数-Duser.name=sgl 2.直接修改@author
eclipse java 注释_Eclipse中自动添加注释（两种）
weixin_34870633的博客
02-12 600
方法一：Eclipse中设置在创建新类时自动生成注释windows-->preferenceJava-->Code Style-->Code Templatescode-->new Java files编辑它${filecomment}${package_declaration}/*** @Author fufu* @Time ${date} ${time}* @Versi...
Eclipse注释模板
iechenyb专栏
07-15 627
eclipse注释规范
编码规范系列（一）：Eclipse Code Templates设置
chenzhou123520的专栏
08-08 755
从工作开始，经历了几个项目的开发，现在的项目一般都是一个团队共同开发，而每个人都有自己的编码习惯，为了统一格式，项目组在项目开发之前都会制定一系列的规范。俗话说约定优于配置，但是在执行过程中往往发现效果不是很好（主要是指编码规范这一方面）。所以我们不得不采取一些措施来协助我们统一项目开发人员的编码风格。主要包括三个方面：设置Code Templates、Eclipse formatter、Chec...
如何在Eclipse中自动添加注释
Java-Jinguo
07-30 358
如果你用的是eclipse3.2,方法如下,其他版本方法类似。通过菜单 Window-&gt;Preference 打开参数设置面板，然后选择：Java -&gt; Code Style -&gt; Code     Templates在右侧选择Comments,将其中的Files项，然后选右边的"Edit"，进入编辑模式：   进入编辑模式后就可以自定义注释了。另外可以插入一些变量，如年、日期...
MyEclipse6.5 注释类及方法等格式设置（Code Templates）
习惯在马桶上思考
04-19 154
原文：http://hi.baidu.com/chenyucode/blog/item/8e2a03dd14693fe076c638cc.html     设置注释模板的入口： Window-&gt;Preference-&gt;Java-&gt;Code Style-&gt;Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍：...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值