Eclipse Java注释模板设置详解

原文：http://blog.csdn.net/ahhsxy/article/details/4542682

设置注释模板的入口： 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="fieldcomment_context" deleted="false" description="字段的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/**
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
*/
</template><template autoinsert="true" context="gettercomment_context" deleted="false" description="getter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/**
 * @return ${bare_field_name}
 */
 </template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="创建的构造函数的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/**
* <p>Title:${file_name} </p>
* <p>Description: 构造函数</p>
* ${tags}
*/
</template><template autoinsert="true" context="filecomment_context" deleted="false" description="已创建的 Java 文件的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}(用一句话描述该文件做什么)
* @author DAIGUANGJIU
* @date ${date} ${time}
* @version V1.0
*/
 </template><template autoinsert="true" context="settercomment_context" deleted="false" description="setter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/**
 * @param ${param} 要设置的 ${bare_field_name}
 */</template><template autoinsert="true" context="typecomment_context" deleted="false" description="创建的类型的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/**
 * @author ${user}
 *
 * ${tags}
 */</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="代表方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/**
* ${tags}
* ${see_to_target}
*/</template><template autoinsert="true" context="overridecomment_context" deleted="false" description="覆盖方法的注释" 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="methodcomment_context" deleted="false" description="非覆盖方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/**
 * ${tags}
 */</template></templa

例子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>
时间： 2024-08-30 23:08:03

Eclipse Java注释模板设置详解的相关文章

Android Studio &quot;佛祖保佑 永无bug&quot; 注释模板设置详解(仅供娱乐)

1.注释模板效果图 今天在网上看到一段有趣的注释,佛祖保佑 永无bug, 效果如下图所示: 代码如下所示: /** * _ooOoo_ * o8888888o * 88" . "88 * (| -_- |) * O\ = /O * ____/`---'\____ * .' \\| |// `. * / \\||| : |||// \ * / _||||| -:- |||||- \ * | | \\\ - /// | | * | \_| ''\---/'' | | * \ .-\__ `

Tomcat与Java Web开发技术详解连载之二

web|详解 2.2.4 部署HTML文件 在helloapp目录下加入index.htm文件,这个文件仅仅用来显示一串带链接的字符"Welcome to HelloApp", 它链接到login.jsp文件.以下是index.htm文件的代码: <html><head><title>helloapp</title></head><body ><p><font size="7"

Tomcat与Java Web开发技术详解连载之三

web|详解 2.2.8 创建并发布WAR文件 Tomcat既可以运行采用开放式目录结构的Web应用,也可以运行WAR文件.在本书配套光盘的sourcecode/chapter2/helloapp目录下提供了所有源文件,只要把整个helloapp目录拷贝到/webapps目录下,即可运行开放式目录结构的helloapp应用.在Web应用的开发阶段,为了便于调试,通常采用开放式的目录结构来发布Web应用,这样可以方便地更新或替换文件.如果开发完毕,进入产品发布阶段,应该将整个Web应用打包为WAR

怎样使用Java Servlet动态生成图片详解

servlet|动态|详解 在Web应用中,经常需要动态生成图片,比如实时股市行情,各种统计图等等,这种情况下,图片只能在服务器内存中动态生成并发送给用户,然后在浏览器中显示出来. 本质上,浏览器向服务器请求静态图片如JPEG时,服务器返回的仍然是标准的http响应,只不过http头的contentType不是text/html,而是image/jpeg而已,因此,我们在Servlet中只要设置好contentType,然后发送图像的数据流,浏览器就能正确解析并显示出图片. 在Java中,jav

host文件设置详解

  host文件设置详解 有很多朋友不清楚Host文件是什么东西?其实hosts文件是用来记录主机ip地址和主机名的对应关系,建立后就可以用主机名来访问主机,而不必记ip地址了.(HOSTS就是本地的一个简易 DNS,它优先于DNS服务器的查询;呵呵,我就是这么认为的.) winxp.win2k系统中存放在windows系统目录中的system32driversetc下面,win98在windows系统目录中下面.(windows系统目录一般就是c:windows). hosts文件是一个纯文本

Java中final关键字详解_php技巧

谈到final关键字,想必很多人都不陌生,在使用匿名内部类的时候可能会经常用到final关键字.另外,Java中的String类就是一个final类,那么今天我们就来了解final这个关键字的用法. 主要介绍:一.final关键字的基本用法.二.深入理解final关键字 一.final关键字的基本用法 在Java中,final关键字可以用来修饰类.方法和变量(包括成员变量和局部变量).下面就从这三个方面来了解一下final关键字的基本用法. 1.修饰类 当用final修饰一个类时,表明这个类不能

Java 中的注解详解及示例代码_java

在Java中,注解(Annotation)引入始于Java5,用来描述Java代码的元信息,通常情况下注解不会直接影响代码的执行,尽管有些注解可以用来做到影响代码执行. 注解可以做什么 Java中的注解通常扮演以下角色 编译器指令 构建时指令 运行时指令 其中 Java内置了三种编译器指令,本文后面部分会重点介绍 Java注解可以应用在构建时,即当你构建你的项目时.构建过程包括生成源码,编译源码,生成xml文件,打包编译的源码和文件到JAR包等.软件的构建通常使用诸如Apache Ant和Mav

CenterOS 中安装Redis及开机启动设置详解_Linux

CenterOS 中安装Redis及开机启动设置详解 从官方下载最新Redis进行安装,官网地址:http://redis.io/download $ wget http://download.redis.io/releases/redis-3.2.3.tar.gz $ tar xzf redis-3.2.3.tar.gz $ cd redis-3.2.3 $ make $ make install Redis启动 RedisServer /path/to/redis.conf Redis关闭(

Java RandomAccessFile的用法详解_java

RandomAccessFile RandomAccessFile是用来访问那些保存数据记录的文件的,你就可以用seek( )方法来访问记录,并进行读写了.这些记录的大小不必相同:但是其大小和位置必须是可知的.但是该类仅限于操作文件. RandomAccessFile不属于InputStream和OutputStream类系的.实际上,除了实现DataInput和 DataOutput接口之外(DataInputStream和DataOutputStream也实现了这两个接口),它和这两个类系毫