// TODO:—使您在Xcode上的注释突出

留下笔记的做法很重要。

对项目进行注释可以帮助您和您的同事跟踪已完成的工作以及尚需完成的工作。

Xcode中内置了三个关键字(TODO,FIXME和MARK),以帮助跟踪项目中需要完成的许多工作。 此外,在脚本编写的帮助下,您可以扩展这些关键字的功能,以确保您的笔记不会被忽略。

在家玩,看看它是如何工作的!

关键词

在Xcode中,打开一个.swift文件。 在代码编辑器上方,您会看到一个状态栏,其中显示了swift文件的位置以及当前在文件中的位置。

单击最后一项将显示一个下拉菜单,列出属性,方法或文件中发生的任何其他情况。 这有助于使用许多代码行和许多功能读取和浏览文件。

Xcode还允许您将自己的项目放置在此列表中,以便其他人,甚至是漫长的一周后甚至您自己,也可以对文件进行快速诊断,以查看是否需要完成或需要修复。

例如:

  // TODO:添加方法来查找大海捞针 

…将产生此结果,并带有项目符号列表图标:

这个:

  // FIXME:删除对jiltedExLover的所有引用 

…将产生此消息,并带有绷带图标:

另一个技巧是,在任何音符上的冒号后面加一个破折号(-),将在下拉列表中创建一个换行符。 所以这:

  // MARK:—不同的部分 

…将产生此消息,并在其上换行:

得到它了? 大!

带注释生成警告和错误

现在也许您在想,这有什么意义? 我是否还不必仔细研究程序,逐个文件,单击下拉菜单,尝试找到该TODO标签? 如果项目有数十个文件怎么办? 我的TODO和FIXME标签不会陷入混乱并被遗忘吗? 如果只有TODO标签没有答案,那么只有一种方法可以使Xcode发出警告!

你猜怎么了?

有!

通过使用一些bash,Xcode会针对任何给定的注释标签自动向您抛出警告或错误。

转到Xcode项目文件上的构建阶段。

单击trop右边的小加号,然后选择Run New Script Phase 。 这里的想法是,当Xcode构建项目时,您将在构建过程中增加另一步。 如果解开运行脚本项的箭头,则会看到一个黑框,其中包含Xcode将在每个版本上运行的脚本。

现在,将其复制并粘贴到该框中: