忘不了的 TODOS & FIXMES & ERRORS

忘不了的 TODOS & FIXMES & ERRORS

IOS小彩虹2021-08-21 22:17:21110A+A-

bglogo

大家好,我是泰戈尔,一个集美貌与智慧于一身的美男子。今晚大萌鱼出去团建了,喝了点酒已经没有意识了。今晚的文章也就只能由我来操刀了。

又是一个暴风大雨的日子,美股的瀑布来得也比往常更猛烈了些。此情此景,我想吟诗一首:“瀑布就像蓝天白云,晴空万里,突然暴风雨,无处躲避,总是让人,始料不及。”

在这么一个暴雨的日子里,大萌鱼跟往常一样编写着代码,改着bug,一切看似都很棒。就这那时,大萌鱼发现了之前标记的一个 TODO:

//TODO: Temporary plan, refactor later

然鹅距离上次标记,时间过去了大半年,我们的大萌鱼早已把这个重构的事情抛之脑外,焦急的大萌鱼挠了挠头,心想:“这特么就很尴尬了啊!”。这时候泰戈尔正好私聊过来拼夕夕瀑布的事,于是大萌鱼就把刚才困惑告诉了泰戈尔。

1-1

一般在我们编写代码时,有时候需要标记什么地方待做的,什么地方需要修复的,我们现在可能没时间修改,那就需要标记一下,以便以后查阅修改。

Xcode也给我们提供了三种实用的简易标记,即 MARKTODOFIXME,现在这些在 Objective-C 或者 Swift 环境下都是可以使用的。需要注意的是 MARKTODOFIXME 均必须大写,Xcode将会在代码中寻找这样的注释,然后以粗体标签的形式将名称显示在导航栏,就如同我们会用 “#pragma mark -” 符号来标记代码区间一样的道理。

MARKTODOFIXME用法如下:

//TODO: 标记将来要完成的内容
//MARK: 标记一件事情
//FIXME: 标记以后要修正或完善的内容

效果如下:

此外还有以下一种标记,Xcode 也是支持的:

// ???:  疑问的地方
/// !!!: 需要注意的地方

然鹅,只是有上面的粗体标签标记的话是远远不够的,在没有或者的提示情况下,开发者很容易就会把之前的标记给忘掉,就跟我们的大萌鱼一样。

那么怎么实现添加自定义的标识,并在编译时,在 warning 或者 error 中显示出来呢?答案就是在 run script build phases 中添加一段 shell 脚本:

  1. 切换到 target-->build phases-->editor-->add run script build phases

  1. 把下面的代码粘贴到 shell 框中
TAGS="TODO:|FIXME:|WARNING:"
ERRORTAG="ERROR:"
find "${SRCROOT}" \( -name "*.h" -or -name "*.m" -or -name "*.swift" \) -print0 | xargs -0 egrep --with-filename --line-number --only-matching "($TAGS).*\$|($ERRORTAG).*\$" | perl -p -e "s/($TAGS)/ warning: \$1/"| perl -p -e "s/($ERRORTAG)/ error: \$1/"

设置完 shell 脚本后,编译代码,WARNINGTODOFIXME 就会出现相应的,而 ERROR 就会被当错编译来处理。

有些人会问了,费这么老大劲,为什么不直接用 #warning 来标记呢?这就仁者见仁,智者见智了。仔细观察下面图中的区别,你就能发现其中的奥妙。

另外在团队协作开发的过程中,对于有些开发者来说,对他们来说是零容忍的,如果频繁使用 #warning,会狠狠的刺痛他们的心扉~

1-2

点击这里复制本文地址 以上内容由权冠洲的博客整理呈现,请务必在转载分享时注明本文地址!如对内容有疑问,请联系我们,谢谢!

支持Ctrl+Enter提交

联系我们| 本站介绍| 留言建议 | 交换友链 | 域名展示
本站资源来自互联网收集,仅供用于学习和交流,请遵循相关法律法规,本站一切资源不代表本站立场,如有侵权、后门、不妥请联系本站删除

权冠洲的博客 © All Rights Reserved.  Copyright quanguanzhou.top All Rights Reserved
苏公网安备 32030302000848号   苏ICP备20033101号-1
本网站由 提供CDN/云存储服务

联系我们