特殊注释：TODO、FIXME、XXX、#pragma mark、#warning

 

1、#pragma mark

#pragma mark -
#pragma mark Table Delegate Methods

从技术上讲，以 #pragma 开头的代码是一条编译器指令，是一个特定于程序或编译器的指令。它们不一定适用于其它编译器或其它环境。如果编译器不能识别该指令，则会将其忽略。

作用：

告诉Xcode编译器，要在编辑器窗格顶部的方法和函数弹出菜单中将代码分隔开，如下图所示：

2、使用特殊注释:

// TODO:
// FIXME:
// !!!:
// ???:

在XCode 3,我们可以用类似这样的注释来方便我们标记需要修改的部分。

在XCode 4,需要做如下设置，才可以在编译后的Warning里面看到我们标记的TODO, FixME等：

进入项目属性设置那个页面 
选择一个Target 
选择Build Phases标签 
点击右下角的Add Build Phase 
展看上面刚出现那一栏Run Script,输入以下内容

KEYWORDS="TODO:|FIXME:|\?\?\?:|\!\!\!:"
find "${SRCROOT}" −name"∗.h"−or−name"∗.m" -print0 | xargs -0 egrep --with-filename --line-number --only-matching "($KEYWORDS).*\$" | perl -p -e "s/($KEYWORDS)/ warning: \$1/"

当然你也可以自己定义一些特殊注释.

在XCode 4看到的效果，如下图所示：

 

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

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

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

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

TODO统计插件:XToDO  https://github.com/trawor/XToDo