特殊注释标记todo的有关信息

阿里巴巴开发规范的对于TODO的说明,粘贴出来有需要的可以参考

 【参考】特殊注释标记,请注明标记人与标记时间。注意及时处理这些标记,通过标记扫描, 经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。  

       1) 待办事宜(TODO):( 标记人,标记时间,[预计处理时间])    表示需要实现,但目前还未实现的功能。  这实际上是一个 Javadoc 的标签,目前的 Javadoc 还没有实现,但已经被广泛使用。只能应用于类,接口和方法(因为它是一个 Javadoc 标签)。  

      2) 错误,不能工作(FIXME):(标记人,标记时间,[预计处理时间])    在注释中用 FIXME 标记某代码是错误的,而且不能工作,需要及时纠正的情况

相关解释

TODO:从字面意思也很好理解,该关键字所表达的含义是待实现,目前还没有实现的功能。 例如//TODO:wait for interfaceA这种形式注释在 SI 中会自动高亮显示,wait for interfaceA就是对于待实现功能的说明。当然不同的IDE在显示上是略有不同的,但是少不了关键字TODO,同时如何显示,以何种颜色显示也是可以设置的。

FIXME:该关键字表达的含义是此处代码实现有问题,先临时实现,需要后续的修正。

XXX:也是表示后续代码需要修正,更多强调的是对代码进行优化。

我们自己写代码的时候对于有疑问的代码通常也会加上注释,但是当涉及到多人开发,像开源项目这种,统一注释风格,例如使用FIXME是非常有必要的。
 

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值