Java中如何设置注释模板呢?

转自:

Java中如何设置注释模板呢?

下文笔者讲述在日常开发IDE工具中设置注释模板的方法分享,如下所示:

Eclipse中设置Java注释模板
Eclipse设置注释模板的菜单:
Window->Preference->Java->
Code Style->
Code Template
然后展开Comments节点即可设置代码模板

Java注释模板标签语法

标签作用域说明
@author标明开发该类模块作者
@version标明该类模块的版本
@see类, 属性, 方法参考转向(相关主题)
@param方法对方法中某参数的说明
@return方法对方法返回值的说明
@exception方法抛出的异常类型
@throws方法与@exception相同
@deprecated方法不建议使用该方法

注释模板例子

文件(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} 
*/ 
构造函数标签
/** 
* <p>Title: </p> 
* <p>Description: </p> 
* ${tags} 
*/

方法(Constructor & Methods)标签
/** 
* @Title: ${enclosing_method} 
* @Description: ${todo} 
* @param ${tags}    设定文件 
* @return ${return_type}    返回类型 
* @throws 
*/

覆盖方法(Overriding Methods)标签
/* (非 Javadoc) 
* <p>Title: ${enclosing_method}</p> 
* <p>Description: </p> 
* ${tags} 
* ${see_to_overridden} 
*/

代表方法(Delegate Methods)标签
/** 
* ${tags} 
* ${see_to_target} 
*/ 
getter方法标签
/** 
* @return ${bare_field_name} 
*/

setter方法标签
/** 
* @param ${param} 要设置的 ${bare_field_name} 
*/
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值