在Eclipse下面使用注释模板自动生成说明

<?xml version="1.0" encoding="UTF-8"?>
<templates>
	<template autoinsert="true" context="filecomment_context"
		deleted="false" description="已创建的 Java 文件的注释" enabled="true"
		id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">
	/**
	 * @Project		${project_name}
	 * @File		${file_name}
	 * @Package		${package_name}
	 * @Version		V1.0
	 * @Date		${date} ${time}
	 * @Author		张三
	 * Copyright (c) All Rights Reserved, ${year}.
	 */
	</template>
	<template autoinsert="true" context="typecomment_context"
		deleted="false" description="创建的类型的注释" enabled="true"
		id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">
	/**
	 * @Description	${todo}
	 * @ClassName	${type_name}
	 * @Date		${date} ${time}
	 * @Author		张三
	 * Copyright (c) All Rights Reserved, ${year}.
	 */
	</template>
	<template autoinsert="true" context="fieldcomment_context"
		deleted="false" description="字段的注释" enabled="true"
		id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">
	/**
	 * @Description ${todo}
	 * @Author		张三
	 * @Date		${date} ${time}
	 * @Fields ${field}	${todo}
	 */
	</template>
	<template autoinsert="true" context="methodcomment_context"
		deleted="false" description="非覆盖方法的注释" enabled="true"
		id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">
	/**
	 * @Description ${todo}
	 * @Author		张三
	 * @Date		${date} ${time}
	 * @param ${tags} 参数
	 * @return ${return_type} 返回类型 
	 * @throws
	 */
	</template>
	<template autoinsert="true" context="delegatecomment_context"
		deleted="false" description="代表方法的注释" enabled="true"
		id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">
	/**
	 * @Description ${todo}
	 * @Author		张三
	 * @Date		${date} ${time}
	 * ${tags}
	 * ${see_to_target}
	 */
	</template>
 
	<template autoinsert="true" context="gettercomment_context"
		deleted="false" description="getter 方法的注释" enabled="true"
		id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">
	/**
	 * @Description ${todo}
	 * @Author		张三
	 * @Date		${date} ${time}
	 * @return ${bare_field_name}
	 */
	</template>
	<template autoinsert="true" context="settercomment_context"
		deleted="false" description="setter 方法的注释" enabled="true"
		id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">
	/**
	 * @Description ${todo}
	 * @Author		张三
	 * @Date		${date} ${time}
	 * @param ${param} ${bare_field_name}
	 */
	</template>
	<template autoinsert="true" context="overridecomment_context"
		deleted="false" description="覆盖方法的注释" enabled="true"
		id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">
	/**
	 * @Description ${todo}
	 * @Author		张三
	 * @Date		${date} ${time}
	 * @param ${tags} 参数
	 * @return ${return_type} 返回类型 
	 * @throws
	 */
	</template>
</templates>

 

 

 第一种：文件导入

 

    使用方式：Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素

 

 

 

第二种：直接找到相应的JAVA / JSP /JS等文件进行手动敲上备注。

 

    使用方式：Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素

 

如：

/**

* @Project${project_name}

* @File${file_name}

* @Package${package_name}

* @VersionV1.0

* @Date${date} ${time}

* @Author张三

* Copyright (c) All Rights Reserved, ${year}.

*/