本文共 4536 字,大约阅读时间需要 15 分钟。
下面详细列出每一个子项的模板格式:
Comments–>Files(Java文件注释)
/** * Project Name:${project_name} * File Name:${file_name} * Package Name:${package_name} * Date:${date}${time} * Copyright (c) ${year}, chenzhou1025@126.com All Rights Reserved. * */
Comments–>Types(Java类注释)
/** * ClassName: ${type_name} * Function: ${todo} ADD FUNCTION. * Reason: ${todo} ADD REASON(可选). * date: ${date} ${time} * * @author ${user} * @version ${enclosing_type}${tags} * @since JDK 1.6 */
Comments–>Fields(类字段注释)
/** * ${field}:${todo}(用一句话描述这个变量表示什么). * @since JDK 1.6 */
Comments–>Constructors(构造函数注释)
/** * Creates a new instance of ${enclosing_type}. * * ${tags} */
Comments–>Methods(Java方法注释)
/** * ${enclosing_method}:(这里用一句话描述这个方法的作用). * ${todo}(这里描述这个方法适用条件 – 可选). * ${todo}(这里描述这个方法的执行流程 – 可选). * ${todo}(这里描述这个方法的使用方法 – 可选). * ${todo}(这里描述这个方法的注意事项 – 可选). * * @author ${user} * ${tags} * @since JDK 1.6 */
Comments–>Overriding methods(重写方法注释)
/** * ${todo} 简单描述该方法的实现功能(可选). * ${see_to_overridden} */
Comments–>Delegate methods(代理方法注释)
/** * ${tags} * ${see_to_target} */
Comments–>Getters(Java Getter方法注释)
/** * ${bare_field_name}. * * @return the ${bare_field_name} * @since JDK 1.6 */
Comments–>Setters(Java Setters方法注释)
/** * ${param}. * * @param ${param} the ${bare_field_name} to set * @since JDK 1.6 */
Code–>New Java files(新建java文件代码模板)
/** * Project Name:${project_name} * File Name:${file_name} * Package Name:${package_name} * Date:${date}${time} * Copyright (c) ${year} All Rights Reserved. * */ ${ filecomment} ${ package_declaration} /** * ClassName:${type_name} * Function: ${todo} ADD FUNCTION. * Reason: ${todo} ADD REASON. * Date: ${date} ${time} * @author ${user} * @version * @since JDK 1.6 * @see */ ${ typecomment} ${ type_declaration}
Code–>Method body(方法体模板)
// ${todo} Auto-generated method stub ${ body_statement}
Code–>Constructor body(构造函数模板)
${ body_statement} // ${todo} Auto-generated constructor stub
Code–>Getter body(字段Getter方法模板)
return ${ field};
Code–>Setter body(字段Setter方法模板)
${ field} = ${ param};
Code–>Catch block body(异常catch代码块模板)
// ${todo} Auto-generated catch block ${ exception_var}.printStackTrace();
其中codetemplates.xml内容如下:
/** * ${bare_field_name}. * * @return the ${bare_field_name} * @since JDK 1.6 */ /** * ${param}. * * @param ${param} the ${bare_field_name} to set * @since JDK 1.6 */ /** * Creates a new instance of ${enclosing_type}. * * ${tags} */ /** * Project Name:${project_name} * File Name:${file_name} * Package Name:${package_name} * Date:${date}${time} * Copyright (c) ${year}, chenzhou1025@126.com All Rights Reserved. * */ /** * ClassName: ${type_name} <br/> * Function: ${todo} ADD FUNCTION. <br/> * Reason: ${todo} ADD REASON(可选). <br/> * date: ${date} ${time} <br/> * * @author ${user} * @version ${enclosing_type}${tags} * @since JDK 1.6 */ /** * ${field}:${todo}(用一句话描述这个变量表示什么). * @since JDK 1.6 */ /** * ${enclosing_method}:(这里用一句话描述这个方法的作用). <br/> * ${todo}(这里描述这个方法适用条件 – 可选).<br/> * ${todo}(这里描述这个方法的执行流程 – 可选).<br/> * ${todo}(这里描述这个方法的使用方法 – 可选).<br/> * ${todo}(这里描述这个方法的注意事项 – 可选).<br/> * * @author ${user} * ${tags} * @since JDK 1.6 */ /** * ${todo} 简单描述该方法的实现功能(可选). * ${see_to_overridden} */ /** * ${tags} * ${see_to_target} */ /** * Project Name:${project_name} * File Name:${file_name} * Package Name:${package_name} * Date:${date}${time} * Copyright (c) ${year}, chenzhou1025@126.com All Rights Reserved. * */ ${filecomment} ${package_declaration} /** * ClassName:${type_name} <br/> * Function: ${todo} ADD FUNCTION. <br/> * Reason: ${todo} ADD REASON. <br/> * Date: ${date} ${time} <br/> * @author ${user} * @version * @since JDK 1.6 * @see */ ${typecomment} ${type_declaration} // ${todo} Auto-generated catch block ${exception_var}.printStackTrace(); // ${todo} Auto-generated method stub ${body_statement} ${body_statement} // ${todo} Auto-generated constructor stub return ${field}; ${field} = ${param};
设置Code Templates的目的主要是为了统一各种注释的格式以及代码的模板,只要设定好Code Templates之后利用Eclipse就可以方便地生成我们自定义的注释,开发人员也容易接受!
转载地址:http://khlbi.baihongyu.com/