Eclipse Code Templates

文件常用元素的注释

文件注释 Files

/*
 * Copyright (c) 1990, 2021, COMPANY and/or its affiliates. All rights reserved.
 *
 *
 */

类型注释 Types

/**
 * TODO.
 * 
 * @author ${user}
 * @version 1.0
 * ${tags}
 */

属性 Fields

/**
 * TODO
 */

构造函数 Constructors

/**
 * ${file_name} 类的构造函数
 *
 * ${tags}
 */

方法 Methods

/**
 * TODO
 *
 * ${tags}
 */

重写方法 Overriding methods

/**
 * 重写 ${enclosing_type} 中定义的 ${enclosing_method} 方法
 *
 * ${see_to_overridden}
 * ${tags}
 */

获取器 Getters

/**
 * @return 返回 ${bare_field_name} 属性的值
 */

设置器 Setters

/**
 * @param ${param} 将属性 ${bare_field_name} 的值设置为 ${param}
 */

配置方式

Eclipse for Windows

Window -> Java -> Code Style -> Code Templates

其他相关事项及操作方式

当配置完成后，有时会发现新创建的文件，并不会生成注释，这里是因为不同版本的Eclipse使模板文件生效，可能需要在不同的地方勾选。

1. 在模板配置时，会有Automatically add comments for new methods and types 的勾选
2. 在创建文件时，会有 Generate comments的勾选