MyEclipse设置Java代码注释模板

// 选中你要加注释的方法或类,按 Alt + shift + J

设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍:

  

文件 (Files)注释标签:

/**  
 * @Title: ${file_name}
 * @Package ${package_name}
 * @Description: ${todo}
 * @author 周  [email protected]
 * @date ${date}  ${time}   
 */

 

 

类型 (Types)注释标签(类的注释):

/**
 * ClassName: ${type_name} 
 * @Description: ${todo}
 * @author 周  [email protected]
 * @date ${date}  ${time}    
 */

 


字段 (Fields)注释标签:

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

 


构造函数标签:

/**

 * <p>Description: </p>

 * ${tags}

 */

 

方法 (Constructor & Methods)标签:

/**
 * @Description: ${todo}
 * @param ${tags}   
 * @return ${return_type}  
 * @throws
 * @author 周  [email protected]
 * @date ${date} ${time}  
 */

 


getter方法标签:

/**

 * @return ${bare_field_name}

 */

setter方法标签:

/**

 * @param ${param} ${bare_field_name}

 */






Eclipse 针对 Java 模板的内置变量
cursor 将编辑器的光标放在这个位置。 N/A
date 插入当前日期。 Oct 20, 2009
dollar 插入货币的文字符号。 $
elemType 尝试猜测具有给定 ID 的这个元素的类型。 MyType
enclosing_method 插入模板被插入其中的那个方法的名称。 method()
enclosing_method_arguments 为包围方法插入参数。 arg1, arg2
enclosing_package 插入当前类的包名。 com.example.ui
enclosing_project 插入包含所编辑的这个类的项目的名称。 myProject
enclosing_type 插入正在编辑的类型(类)的名称。 MyType
exception_variable_name 插入一个异常变量名称,进行最佳猜测。 e, ioe
file 文件的简称。 MyType.java
import 如果尚未导入,那么针对给定类型插入一个导入声明。 import com.example.ui.MyOtherType
importStatic 与 import 相同,只不过是静态导入。 import static com.example.ui.MyOtherType.*
line_selection 将选中的行插入到这里。这对用模板包装行是很有用的。 以选中行作为主体的 do、while 循环
primary_type_name 没有扩展名的文件简称。 MyType
time 插入当前的时间。 9:09:35 a.m.
todo 注释中的 TODO 标记。 TODO
user 当前用户的名字。 ngood
var 解析为本地变量,如果不只一个,就提供一个列表。 myvar
word_selection 插入当前选中的单词。 N/A
year 将现在的年份插入到代码中。 2009
变量的另一个很棒的特性就是您可以自己创建一个。它们并不会自动地解析成任何值。不过,在模板插入后,您即可以将值输入到模板内。在键入到变量中时,所键入的值就会被插入到该变量出现在代码中的所有位置。请看清单 3 中的模板。

你可能感兴趣的:(MyEclipse设置Java代码注释模板)