Eclipse注释模板与规范

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

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

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

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

字段(Fields)注释标签:

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

/**
*

Title:


*

Description:


* ${tags}
*/

方法(Constructor & Methods)标签:

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

覆盖方法(Overriding Methods)标签:

/* (非 Javadoc)
*

Title: ${enclosing_method}


*

Description:


* ${tags}
* ${see_to_overridden}
*/

代表方法(Delegate Methods)标签:

/**
* ${tags}
* ${see_to_target}
*/
getter方法标签:

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

setter方法标签:

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



/**
* 创建一个新的实例 ${enclosing_type}.
*
* ${tags}
*/


/**
* @param ${param} the ${bare_field_name} to set
*/


/**
* 此方法描述的是:
* @author: wangxiongdx@163.com
* @version: ${date} ${time}
*/


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


/**
* 文件名:${file_name}
*
* 版本信息:
* 日期:${date}
* Copyright 足下 Corporation ${year}
* 版权所有
*
*/


/**
* ${bare_field_name}
*
* @return the ${bare_field_name}
* @since   CodingExample Ver(编码范例查看) 1.0
*/


/* (non-Javadoc)
* ${see_to_overridden}
*/


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


/**
* 此类描述的是:
* @author: wangxiongdx@163.com
* @version: ${date} ${time}
*/





/**
* 创建一个新的实例 ${enclosing_type}.
*
* ${tags}
*/


/**
* @param ${param} the ${bare_field_name} to set
*/


/**
* 此方法描述的是:
* @author: wangxiongdx@163.com
* @version: ${date} ${time}
*/


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


/**
* 文件名:${file_name}
*
* 版本信息:
* 日期:${date}
* Copyright 足下 Corporation ${year}
* 版权所有
*
*/


/**
* ${bare_field_name}
*
* @return the ${bare_field_name}
* @since   CodingExample Ver(编码范例查看) 1.0
*/


/* (non-Javadoc)
* ${see_to_overridden}
*/


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


/**
* 此类描述的是:
* @author: wangxiongdx@163.com
* @version: ${date} ${time}
*/

来自为知笔记(Wiz)PromoteWiz=0

评论

暂无评论