Eclipse配置注释模板（code templates）

首选项位置

配置路径为：Window–>Preferences–>Java–>Code Style–>Code Templates

设置自动添加注释

在Window–>Preferences–>Java–>Code Style–>Code Templates下勾选Automatically add Comments for new Methods and types

手动配置

手动点击每个注释类型，Edit 即可编辑 模板

详细介绍

Code Templates下有两类，一类Comments表示注释；一类Code表示为代码模板

Comments(注释模板)：

    Files(文件注释):filecomment_context
    Types(文件注释):typecomment_context
    Fields(类字段注释):fieldcomment_context
    Constructors(构造方法注释):constructorcomment_context
    Methods(方法体注释):methodcomment_context
    Overriding methods(重写方法注释):overridecomment_context
    Delegate methods(代理方法注释):delegatecomment_context
    Getters(get方法注释):gettercomment_context
    Setters(set方法注释):settercomment_context

Code(代码模板)：

New Java files(类模板):newtype_context
Class body(类体模板):classbody_context
Interface body(接口模板):interfacebody_context
Enum body(枚举模板):enumbody_context
Annotation body(注释模板):annotationbody_context
Method body(方法体模板):methodbody_context
constructor body(构造函数模板):constructorbody_context
Getter body(get方法模板):getterbody_context
Setter body(set方法模板):setterbody_context
Catch block body(异常catch代码模板):catchblock_context

注释模板中的常用动态参数说明如下：

${project_name}：项目名
${package_name}：包名
${file_name}：文件名
${type_name}：类名
${user}：当前用户
${date}：当前日期
${time}：当前时间
${enclosing_method}：方法名
${tags}：入参及返回参数

普通配置记录

Comments(注释模板)：

Files(文件注释):filecomment_context

/**
 * @模块名：${project_name}
 * @包名：${package_name}
 * @描述：${file_name}
 * @版本：1.0
 * @创建人：${user}
 * @创建时间：${date}${time}
 */

Types(文件注释):typecomment_context

/**
 * @模块名：${project_name}
 * @包名：     ${package_name}
 * @类名称：${type_name}
 * @类描述：
 * @版本：      1.0
 * @创建人：${user}
 * @创建时间：${date}${time}
 * ${tags}
 */

Fields(类字段注释):fieldcomment_context

// 

Constructors(构造方法注释):constructorcomment_context

/**
 * @參數：${tags}
 */

Methods(方法体注释):methodcomment_context

/**
 * @方法名：${enclosing_method}
 * @方法描述:
 * ${tags}
 * @修改描述:
 * @版本：1.0
 * @创建人：${user}
 * @创建时间：${date} ${time}
 * @修改人：${user}
 * @修改时间：${date} ${time}
 */

Overriding methods(重写方法注释):overridecomment_context

/**
 * (non-Javadoc)
 * ${see_to_overridden}
 * ${tags}
 */

Delegate methods(代理方法注释):delegatecomment_context

Getters(get方法注释):gettercomment_context

Setters(set方法注释):settercomment_context

Code(代码模板)：

New Java files(类模板):newtype_context
Class body(类体模板):classbody_context
Interface body(接口模板):interfacebody_context
Enum body(枚举模板):enumbody_context
Annotation body(注释模板):annotationbody_context
Method body(方法体模板):methodbody_context
constructor body(构造函数模板):constructorbody_context
Getter body(get方法模板):getterbody_context
Setter body(set方法模板):setterbody_context
Catch block body(异常catch代码模板):catchblock_context

P3C 符合的设置

Comments(注释模板)：

Files(文件注释):filecomment_context

/**
 * Copyright © 2020, lushunde or www.lushunde.com site. All rights reserved.
 * @package ${project_name} ${package_name} 
 * @author ${user}
 * @node 
 */

Types(文件注释):typecomment_context

/**
 * @node 
 * @package ${project_name} ${package_name} 
 * @version 1.0
 * @date ${date}
 * @author ${user}
 * @since JDK1.8
 */

Fields(类字段注释):fieldcomment_context

/** 值为{@value} */

Constructors(构造方法注释):constructorcomment_context

/**
 * ${tags}
 * @author： ${user}
 * @date： ${date}${time}
 */

Methods(方法体注释):methodcomment_context

/**
 * ${tags}
 * @author： ${user} ${date}
 */

Overriding methods(重写方法注释):overridecomment_context

/* (non-Javadoc)
 * ${see_to_overridden}
 */

Delegate methods(代理方法注释):delegatecomment_context

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

Getters(get方法注释):gettercomment_context

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

Setters(set方法注释):settercomment_context

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

Code(代码模板)：

自动实现的代码，默认即可

New Java files(类模板):newtype_context
Class body(类体模板):classbody_context
Interface body(接口模板):interfacebody_context
Enum body(枚举模板):enumbody_context
Annotation body(注释模板):annotationbody_context
Method body(方法体模板):methodbody_context
constructor body(构造函数模板):constructorbody_context
Getter body(get方法模板):getterbody_context
Setter body(set方法模板):setterbody_context
Catch block body(异常catch代码模板):catchblock_context

JavaDoc文档生成