代码中特殊的注释技术——TODO、FIXME和XXX的用处

转载 2012年03月23日 11:48:25

作者:reille

本博客网址:http://blog.csdn.net/reille/,转载本博客原创文章请注明出处。

本文内容概要: 代码中特殊的注释技术——TODO、FIXME和XXX的用处。


前言:

今天在阅读Qt  Creator的源代码时,发现一些注释中有FIXME英文单词,用英文词典居然查不到其意义!
实际上,在阅读一些开源代码时,我们常会碰到诸如:TODO、FIXME和XXX的单词,它们是有其特殊含义的。、

TODO: + 说明
如果代码中有该标识,说明在标识处有功能代码待编写,待实现的功能在说明中会简略说明。

FIXME: + 说明
如果代码中有该标识,说明识处代码需要修正,甚至代码是错误的,不能工作,需要修复,如何修正会在说明中简略说明。

XXX: + 说明
如果代码中有该标识,说明识处代码虽然实现了功能,但是实现的方法有待商榷,希望将来能改进,要改进的地方会在说明中简略说明。

eclipse中特殊的注释:
在eclipse中,TODO、FIXME和XXX都会被eclipse的task视图所收集。在项目发布前,检查一下task视图是一个很好的习惯。此外,在eclipse中,我们可自定义自己的特殊注释标签。如在C/C++中,进入window—>preferences—>C/C++—>Task Tags窗口即可添加特殊标签,默认只有TODO、FIXME和XXX。

相关文章推荐

代码注释___TODO__FIXME__XXX____提示

在阅读Qt  Creator的源代码时,发现一些注释中有FIXME英文单词,用英文词典居然查不到其意义! 实际上,在阅读一些开源代码时,我们常会碰到诸如:TODO、FIXME和XXX的单词,它们是有...

MyEclipse工具中,默认标签TODO,XXX,FIXME和自定义标签的使用。

MyEclipse中的一些特殊的注释技术包括: 1.    // TODO —— 表示尚未完成的待办事项。 2.    // XXX —— 表示被注释的代码虽然实现了功能,但是实现方案有待商榷,希...

Android Studio的TODO,FIXME

在Eclipse中可以用TODO,FIXME,XXX注释标明需要完成或修改或有待改进的代码,同时可以打开tasks视图查看项目中所有的TODO。在Android studio中同样提供这样的功能(但是...

iOS 标注#pragma mark、FIXME、TODO等等

分组功能: 1、#pragma mark - 注释功能: 1、#pragma mark 2、// MARK: 3、// TODO: 4、// FIXME: 5、// !!!: ...

在Xcode4中显示TODO: FIXME:等标记

在用eclipse时如果在注释里写了TODO则会自动的添加到TODO LIST里面去,比如说有个接口没完善但是现在来不及做了,就在注释里写上TODO,然后后面记上有什么事情还没有做,eclipse就会...

在Xcode4中显示TODO: FIXME:等标记

在用eclipse时如果在注释里写了TODO则会自动的添加到TODO LIST里面去,比如说有个接口没完善但是现在来不及做了,就在注释里写上TODO,然后后面记上有什么事情还没有做,eclipse就会...

网页代码小技术大用处

  • 2009-07-30 18:00
  • 11KB
  • 下载

session与cookie技术应用(附详细代码示例以及注释)

最近开始写android网络应用,不得不好好学习服务端语言,选择PHP作为项目的服务端是因为觉得PHP相对要好入门一下. 之所以博文总是断断续续的,是因为我后来回学校继续学习了,平时忙于专业学习,宿舍...
  • vvqiu
  • vvqiu
  • 2016-01-04 01:21
  • 423

JAVA基础【3.2】《Java核心技术1》Java的基本程序设计结构-代码注释

1 代码注释类型 1.1 单行注释
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:深度学习:神经网络中的前向传播和反向传播算法推导
举报原因:
原因补充:

(最多只允许输入30个字)