TODO、FIXME和XXX的用处

1

今天在VIM查看Linux设备驱动代码时,发现有一些注释只有短短的5个字母—- /* FIXME */,之所以引起我的注意是因为这5个字母居然是“黄底黑字”,而且也不像是个英文单词,后来请教度娘才知道原来这是一种代码中特殊的注释技术。
实际上,在阅读一些开源代码时,经常会碰到诸如:TODO、FIXME和XXX的单词,它们是有其特殊含义的。

/* TODO: 说明 */
to do表示有待进行,即在该注释处有功能代码需要编写,待实现的功能在说明中描述。

/* FIXME: 说明 */:
fix me表示来修复我吧,即该注释处的代码需要修正,甚至代码是错误、不能工作的,需要修复,如何修正会在说明中描述。

/* XXX: 说明 */:
如果代码中有这种注释,说明此处代码虽然实现了功能,但是实现的方法有待商榷,希望将来能改进,要改进的地方会在说明中描述。

一条评论

Leave A Reply