Eclipse中添加文档注释快捷键与导入模板文件codetemplates.xml

Eclipse中添加文档注释快捷键

例如：

/**

 * @desc: test

 * @author: kpchen

 * @createTime: 2014年11月5日下午3:57:19

 * @history:

 * @version: v1.0

 */

快捷键为：ALT + SHIFT +J

想更换为其他的快捷键：

Window-->Preferences-->General-->Keys;找到"add javadoc comment"更改自己喜欢的快捷键。

修改注释内容

另外如果觉得注释也不爽时也可以修改，修改的方法有两种：

1.直接在eclipse给的模板下进行修改

2.自己编写一个xml文档导入进去

那就来先说说第一种方法吧：

打开eclipse

Window-->Preferences-->Java-->Code Style -->Code Templates --> Comments --> types --> Edit

/**     
* 项目名称：${project_name}  
* 类名称：${type_name}  
* 类描述：  
* 创建人：${user}  
* 创建时间：${date} ${time}  
* 修改人：${user}  
* 修改时间：${date} ${time}  
* 修改备注：  
* @version     
*/

第二种方法是：

点击右边的import按钮选择你写好的模板.xml文件

下面是一个注释行模板codetemplates.xml，可以直接导入使用。贴出源码供大家参考一下

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<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="true" context="constructorcomment_context"
		deleted="false" description="Comment for created constructors"
		enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"
		name="constructorcomment">
		/**
		* ${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">
		/*
		* Copyright @ ${year} com.iflysse.trains
		* ${project_name} ${time}
		* All right reserved.
		*
		*/
	</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">
		/**
		* @desc: ${project_name}
		* @author: kpchen
		* @createTime: ${date} ${time}
		* @history:
		* @version: v1.0
		* ${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">
		/**
		* 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">
		/**
		* @author: kpchen
		* @createTime: ${date} ${time}
		* @history:
		* ${tags} ${return_type}
		*/
	</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="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="true" context="newtype_context" deleted="false"
		description="Newly created files" enabled="true"
		id="org.eclipse.jdt.ui.text.codetemplates.newtype" name="newtype">
		${filecomment}
		${package_declaration}

		${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>