代码中的特殊注释标记

项目开发过程中码中会出现一些特殊的注释标记。这些特殊的注释标记代表着一约定俗成的含义,在一些开源代码中也会使用到,了解其含义有助于了解整体代码状况。

最为常见的注释标记有如下三个TODO、FIXME、XXX,很多IDE,例如sourceinsight,eclipse都有对着三种注释进行处理,例如soureinsight对于TODO都是默认高亮显示的。当然soureinsight等IDE也会针对像FIXME这种注释也是有自定义设置等,以便突出显示的。
eclipse还会对这些注释收集显示,以便统一处理。但是总的来说这些毕竟是注释,也就是预处理阶段直接删除的东西,主要的作用就是方便代码的阅读,在代码开发的时候起到突出说明作用,方便多人的协同开发。同时这些注释在多种语言中是通用的,例如C,java等。

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

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

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

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

本文为优快云村中少年原创文章，转载记得加上小尾巴偶，博主链接这里。