如何在Xcode中标记“待办事项”注释?
目前我正在处理基于iOS的图像操作任务。
问题:
我正在处理不同的模块。 所以,如果将来需要在模块中添加某些内容,我想将其标记为“待办事项”。 有没有其他的macros或类似的添加一个在Xcode中做笔记?
我试过了:
对于这个目前我正在使用#pragma
像:
#pragma mark - #pragma mark To do: Add the Image processing methods.
我有:
但是它在方法部分列出如下:
我真正需要的是:
问题是,它列在方法列表下面,所以有时候我忘了从这个部分中删除它,在整个源代码中很难find它。 (search#pragma结果以显示整个列表)
技术细节:
我正在使用Xcode版本4.6.2。
// TODO: the thing todo
你是如何显示待办事项的任务。
我知道了。
写评论如:
//TODO: do something
会做的伎俩。
我有这样的东西:
还有很多选项,如 :
-
// FIXME: Midhun
-
// ???: Midhun
-
// !!!: Midhun
-
// MARK: Midhun
使用
//TODO: some thing here
如果你想要做的只是在下拉列表中查看待办事项列表
如果你想侵入你可以使用#warning
标记:
#warning this will create a compiler warning.
而当你build立应用程序时,你会得到一个编译器警告(一个黄色的三angular形,而不是一个编译器错误),这是多一点“在你面前”提醒你你需要做的事情。
下面的脚本可以看到所有必需的标签,如警告。
- 在Project Navigator中select您的项目
- 打开边栏中的目标并移至“构build阶段”选项卡
- 点击“+”号
- select“新build脚本生成阶段”
-
将下面的脚本添加到“运行脚本” 剧本:
KEYWORDS="TODO:|FIXME:|DevTeam:|XXX:" find "${SRCROOT}" \( -name "*.h" -or -name "*.m" -or -name "*.swift" \) -print0 | xargs -0 egrep --with-filename --line-number --only-matching "($KEYWORDS).*\$" | perl -p -e "s/($KEYWORDS)/ warning: \$1/"
原来的答案是从这里采取的
另一种select是Xcode的XToDo插件。
你可以使用XToDo插件
https://github.com/trawor/XToDo
使用Ctrl + t来打开/closures列表窗口
使用恶意软件轻松安装,使用ctrl + t来打开/closures列表窗口
我倾向于完全写// // TODO:Blah等等等等
然后我只是做一个COMMAND-SHIFT-F并寻找“// TODO”。
使用文件大纲下拉菜单将只显示当前文件的TODO,但我倾向于看到我的项目的TODO状态。
粗糙的解决scheme,但这是它的工作。
我开始
// TODO: Implement bubble sort
。
然后我join了一个大项目,有时我需要一个待办事项来比WIP提交更长的时间,所以为了区别我的待办事项和我的同事,我把我的待办事项名称与我的名字分开:
// TODO: SM: Implement bubble sort
有时我想要更多的可见性,所以我开始在一些地方使用编译指示警告。
#warning Implement bubble sort
有一天,我决定通过在我的cflags中添加-Werror
来打开硬模式。 不幸的是,这使得编译警告无用,因为它们阻止编译。 所以我回到使用// TODO:
直到杰夫Nadeau告诉我,我可以把
-Wno-error=#warnings
在我的cflags,以便不会将编译警告视为错误。 所以现在#warning
和-Werror
可以一起生活。
另外一个简单的方法是,如果你不想混淆列表栏的方法,那么就是使用像//Todo:
这样的注释中的约定//Todo:
而当你想要集中地处理它们时,只需selectFind导航,大小写和search//Todo:
我更喜欢这个,因为我不喜欢像spagetti-code一样的方法。 是的,我经常有很多Todo:的;)
#error
和
#warning
也用于C编程