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>


相关文章
|
7天前
|
Java Android开发
Eclipse Java 构建路径
Eclipse Java 构建路径
16 3
|
1月前
|
存储 缓存 Java
java基础:IO流 理论与代码示例(详解、idea设置统一utf-8编码问题)
这篇文章详细介绍了Java中的IO流,包括字符与字节的概念、编码格式、File类的使用、IO流的分类和原理,以及通过代码示例展示了各种流的应用,如节点流、处理流、缓存流、转换流、对象流和随机访问文件流。同时,还探讨了IDEA中设置项目编码格式的方法,以及如何处理序列化和反序列化问题。
67 1
java基础:IO流 理论与代码示例(详解、idea设置统一utf-8编码问题)
|
27天前
|
搜索推荐 Java 数据库连接
Java|在 IDEA 里自动生成 MyBatis 模板代码
基于 MyBatis 开发的项目,新增数据库表以后,总是需要编写对应的 Entity、Mapper 和 Service 等等 Class 的代码,这些都是重复的工作,我们可以想一些办法来自动生成这些代码。
30 6
|
1月前
|
Java Linux iOS开发
如何设置 Java 的环境变量
设置Java环境变量是使用Java开发工具和运行Java程序的前提。主要步骤包括:安装JDK,配置系统环境变量中的JAVA_HOME、PATH和CLASSPATH,确保命令行可直接调用javac和java命令。
|
1月前
|
安全 Java Linux
java程序设置开机自启
java程序设置开机自启
101 1
|
1月前
|
算法 Java Linux
java制作海报四:java BufferedImage 转 InputStream 上传至OSS。png 图片合成到模板(另一个图片)上时,透明部分变成了黑色
这篇文章主要介绍了如何将Java中的BufferedImage对象转换为InputStream以上传至OSS,并解决了png图片合成时透明部分变黑的问题。
63 1
|
1月前
|
Linux Android开发 Windows
IDEA如何设置成Eclipse的快捷键
【10月更文挑战第9天】这段内容介绍了如何在 IntelliJ IDEA 中设置类似 Eclipse 的快捷键。主要包括:1) 打开设置;2) 进入快捷键设置页面;3) 选择 Eclipse 快捷键方案;4) 可选的自定义调整。通过这些步骤,可以让熟悉 Eclipse 的用户更快适应 IDEA。
303 4
|
1月前
|
Java
Java PDF模板生成PDF
Java PDF模板生成PDF
39 1
|
1月前
|
小程序
java--微信小程序发送模板消息
java--微信小程序发送模板消息
107 0
|
3月前
|
小程序 Java
【aspose-words】Aspose.Words for Java模板语法详细剖析
本文通过详细分析Aspose.Words for Java模板语法,介绍了使用条件块、变量和动态合并表格单元格三个常用模板标签,并结合实际案例进行演示。通过这三个标签的实操,帮助读者更好地掌握Aspose.Words的使用技巧。此外,还提供了官方文档链接以便进一步学习。
142 0
【aspose-words】Aspose.Words for Java模板语法详细剖析

推荐镜像

更多