eclipse注释和注释模板123

注释 
注释类型

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

1
2
3
4
/* 
* 多行注释
*/
String type = "多行注释";
1
2
3
/**
* 文档注释
*/publicclass Dummy{}

快捷键

添加/取消单行注释: Ctrl+/

添加类的文档注释: Ctrl+Shift+j

注释模板                               

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

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

Comments节点 下的元素介绍:

  1. File节点(文件注释标签)
1
2
3
4
5
6
7
8
/**   
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}(用一句话描述该文件做什么)
* @author fsjohnhuang
* @date ${date} ${time}
* @version V1.0
*/
  1. Types节点(类注释标签)
1
2
3
4
5
6
7
8
/** 
* @ClassName: ${type_name}
* @Description: ${todo}(这里用一句话描述这个类的作用)
* @author fsjohnhuang
* @date ${date} ${time}
*
* ${tags}
*/
  1. Fields节点(字段注释标签)
1
2
3
/** 
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
*/
  1. Constructor节点(构造函数注释标签)
1
2
3
4
5
/** 
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/
  1. Method节点(方法注释标签)
1
2
3
4
5
6
7
/** 
* @Title: ${enclosing_method}
* @Description: ${todo}(这里用一句话描述这个方法的作用)
* @param ${tags} 参数说明
* @return ${return_type} 返回类型
* @throws
*/
  1. Overriding Methods节点(覆盖方法注释标签)
1
2
3
4
5
6
/*
* Title: ${enclosing_method}
*Description:
* ${tags}
* ${see_to_overridden}
*/
  1. Delegate Methods节点(代理方法注释标签)
1
2
3
4
/** 
* ${tags}
* ${see_to_target}
*/
  1. getter节点(getter方法注释标签)
1
2
3
/** 
* @return ${bare_field_name}
*/
  1. setter节点(setter方法注释标签)
1
2
3
/** 
* @param ${param} 要设置的 ${bare_field_name}
*/

导入、导出注释模板

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