Eclipse中设置作者日期等Java注释模板详解

Eclipse作为一种集成开发环境（Integrated Development Environment）,可以通过设置自动添加Javadoc注释信息来进行标识。

常用的注释

首先来认识几个常用的注解：

• @author 作者名
• @date 日期
• @version 版本标识
• @parameter 参数及其意义
• @return 返回值
• @throws 异常类及抛出条件
• @deprecated 引起不推荐使用的警告
• @override 重写

IDE中入口

注释模板的入口：Window->Preference->Java->Code Style->Code Template

 设置对应模板（建议）

只是个建议，自己可以根据需求自行修改

类型(Types)注释标签（类的注释）：

/**
* @ClassName: ${type_name}
* @Description: ${todo}
* @author ${user}
* @date ${date}
* ${tags}
*/

文件(Files)注释标签：


/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}
* @author ${user}
* @date ${date}
* @version V1.0
*/

字段(Fields)注释标签：

/**
* @Fields field:field:{todo}
*/

构造函数(Constructor)标签：

/**
* 创建新实例 ${enclosing_type}.
* ${tags}
*/

方法(Methods)标签：

/**
* @Title: ${enclosing_method}
* @Description: ${todo}
* @param ${tags} 
* @return ${return_type}
* @throws
*/

覆盖方法(Overriding Methods)标签：

/**
* Title: ${enclosing_method}
* @Description: ${todo}
* ${tags}
* ${see_to_overridden}
*/

代表方法(Delegate Methods)标签：

/**
* ${tags}
* ${see_to_target}
*/

getter方法标签：

/**
* @return ${bare_field_name}
*/

setter方法标签：

/**
* @param ${param} the ${bare_field_name} to set
*/

           

 导入与导出

也可以复制以下配置，直接导入就可以了，新建文件“codetemplates.xml”

<?xml version="1.0" encoding="UTF-8"?>
<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 ${user}
* @date ${date}
* ${tags}
*/
</template>
<templates>
<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}
* @author ${user}
* @date ${date}
* @version V1.0  
*/
</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:field:{todo}
*/
</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">
/**
* 创建新实例 ${enclosing_type}.
* ${tags}
*/
</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
*/
</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">
/**
* Title: ${enclosing_method}
* @Description: ${todo}
* ${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="gettercomment_context"
    deleted="false"
    description="Comment for getter method"
    enabled="true"
    id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"
    name="gettercomment">
/**
* @return ${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>
</templates>