Java Eclipse自动生成方法注释_Eclipse注释模板设置详解
2014-01-10 11:12:00  By: dwtedx

做为一个优秀的程序员、是十分不想写注释的、还记得我刚刚参加实习的时候、除了自己觉得理解比较难的加上了注释以外、基本上都是没有注释的、所以介于我的情况是必须要设置自动生成注释这个功能的、分享一下设置方法、以便以后使用

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

现就每一个元素逐一介绍:


文件(Files)注释标签:

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


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

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


字段(Fields)注释标签:

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


构造函数标签:

/** 
 * @Title: ${enclosing_method} 
 * @Description: 构造方法
 * ${tags} 
 */


方法(Constructor & Methods)标签:

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


覆盖方法(Overriding Methods)标签:

/** 
 * @Title: ${enclosing_method} 
 * @Description: (非 JavaDoc)
 * ${tags} 
 * ${see_to_overridden} 
 */


代表方法(Delegate Methods)标签:

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


getter方法标签:

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


setter方法标签:

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


另外还有JSP和XML的注释自动生成、我目前还没有设置、如果有想设置的可以自己查一下、其实我觉得JSP和XML自动生成注释的必要性也不是很迫切

若资源对你有帮助、浏览后有很大收获、不妨小额打赏我一下、你的鼓励是维持我不断写博客最大动力

想获取DD博客最新代码、你可以扫描下方的二维码、关注DD博客微信公众号(ddblogs)

或者你也可以关注我的新浪微博、了解DD博客的最新动态:DD博客官方微博(dwtedx的微博)

如对资源有任何疑问或觉得仍然有很大的改善空间、可以对该博文进行评论、希望不吝赐教

为保证及时回复、可以使用博客留言板给我留言: DD博客留言板(dwtedx的留言板)

感谢你的访问、祝你生活愉快、工作顺心、欢迎常来逛逛


快速评论


技术评论

  • 该技术还没有评论、赶快抢沙发吧...
DD记账
top
+