前言 : 今天在阅读代码的时候发现了以前不怎么用的特殊注释 //TODO 和 //FIXME,好奇之下就查阅了一下资料,这里分享给大家TODO: + 说明:如果代码中有该标识,说明在标识处有功能代码待编写,待实现的功能在说明中会简略说明例如 :FIXME: + 说明:如果代码中有该标识,说明标识处代码需要修正,甚至代码是错误的,不能工作,需要修复,如何修正会在说明中简略说明。例如 :...
代码中
特殊
注释
——
TODO
、
FIXME
、XXX、HACK
TODO
:英语翻译为待办事项,备忘录。如果代码中有该标识,说明在标识处有功能代码待编写,待实现的功能在说明中会简略说明。
FIXME
:可以拆成短语,
fix
me ,意为修理我。如果代码中有该标识,说明标识处代码需要修正,甚至代码是错误的,不能工作,需要修复,如何修正会在说明中简略说明。
XXX:如果代码中有该标识,说明标识处代码虽然实...
FIXME
: 修理我,代码需要修正,甚至代码是错误的,不能工作,需要修复,如何修正会在说明中简略说明。
XXX: 如果代码中有该标识,说明标识处代码虽然实现了功能,但是实现的方法有待商榷,希望将来能改进,要改进的地方会在说明中简略说明。
HACK: 英语翻译为砍。如果代码中有该标识,说明标识处代码我们需要根据自己的需求去调整程序代码。
今天在阅读Qt Creator的源代码时,发现一些
注释
中有
FIXME
英文单词,用英文词典居然查不到其意义!
实际上,在阅读一些开源代码时,我们常会碰到诸如:
TODO
、
FIXME
和XXX的单词,它们是有其
特殊
含义的。、
TODO
: + 说明:
如果代码中有该标识,说明在标识处有功能代码待编写,待实现的功能在说明中会简略说明。
FIXME
: + 说明:
如果代码中有该标识,
编程时//
TODO
注释
的作用
在平时的编程中,总是能在一些编译器自动生成的代码或者大佬的程序中看到//
TODO
...的
注释
,一直很疑惑到底是什么意思,以为是个
注释
规范,其实是项目管理者要求代码编写人员在式样无法确定,或者其他原因不能完成编程的时候,用//
TODO
进行
注释
,那么管理者就可以随时的通过任务列表查看工作状况和问题点来进行控制。
在intellij中可以设置自己专属的...