Java魔法堂：注释和注释模板-白红宇

一、注释　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　

1. 注释类型

[a]. 单行注释

// 单行注释String type = "单行注释";

[b]. 多行注释

/*  * 多行注释 */String type = "多行注释";

[c]. 文档注释

/** * 文档注释 */public class Dummy{}

2. 快捷键

[a]. 添加/取消单行注释： Ctrl+/

[b]. 添加类的文档注释： Ctrl+Shift+j

二、注释模板　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　

作用：定义文件、类和方法等默认的注释格式，减少手工输入的工作量。

1. 设置注释模板的入口：点击 Window->Preference->Java->Code Style->Code Template ，然后展开 Comments节点。

2. Comments节点下的元素介绍：

File节点（文件注释标签）

/**   * @Title: ${file_name} * @Package ${package_name} * @Description: ${todo}(用一句话描述该文件做什么) * @author fsjohnhuang* @date ${date} ${time} * @version V1.0   */

Types节点（类注释标签）

/** * @ClassName: ${type_name} * @Description: ${todo}(这里用一句话描述这个类的作用) * @author fsjohnhuang* @date ${date} ${time} * * ${tags} */

Fields节点（字段注释标签）

/** * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么) */

Constructor节点（构造函数注释标签）

/** * Title: 
 * Description: 
 * ${tags} */

Method节点（方法注释标签）

/** * @Title: ${enclosing_method} * @Description: ${todo}(这里用一句话描述这个方法的作用) * @param ${tags}  参数说明 * @return ${return_type}    返回类型 * @throws */

Overriding Methods节点（覆盖方法注释标签）

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

Delegate Methods节点（代理方法注释标签）

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

getter节点（getter方法注释标签）

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

setter节点（setter方法注释标签）

/** * @param ${param} 要设置的 ${bare_field_name} */

3. 导入、导出注释模板

在 Window->Preference->Java->Code Style->Code Template 下可导入导出注释模板。