Objective-C 中的 TODO、FIXME 注释标签

导读

在 Xcode 中通过 Objective-C 语言编写代码时,你可能经常会使用 #pragma mark 预处理指令来实现代码注释,或者对类实现文件中的方法按照功能进行分组。其实,在 Xcode 中,也可以实现 TODOFIXME 等高亮语法

#pragma mark 语法

之前我在 Xcode 使用技巧/代码整洁小技巧 #pragma mark 部分也有探讨过 #pragma mark 语法的常见用法。

简单来说,#pragma mark 就是用来组织类实现文件中的代码,并对方法进行实现合理分组(分割代码段)的预处理指令。

使用方式:

  • 添加分割线:#pragma mark -
  • 添加功能说明:#pragma mark 功能说明
  • 同时添加分割线和功能说明:#pragma mark - 功能说明

这里我推荐 禅与 Objective-C 编程艺术#pragma 中的分组形式对代码进行分组。

- (void)dealloc { /* ... */ }
- (instancetype)init { /* ... */ }

#pragma mark - Lifecycle (View 的生命周期方法)

- (void)viewDidLoad { /* ... */ }
- (void)viewWillAppear:(BOOL)animated { /* ... */ }
- (void)didReceiveMemoryWarning { /* ... */ }

#pragma mark - Custom Accessors (自定义访问器,即 Getter 和 Setter 方法)

- (void)setCustomProperty:(id)value { /* ... */ }
- (id)customProperty { /* ... */ }

#pragma mark - IBActions (按钮执行的动作方法)  

- (IBAction)submitData:(id)sender { /* ... */ }

#pragma mark - Public (类对外公开的方法,即在头文件中声明过的方法)

- (void)publicMethod { /* ... */ }

#pragma mark - Private (类内部的私有方法)

- (void)zoc_privateMethod { /* ... */ }

#pragma mark - UITableViewDataSource (遵守的代理协议方法)

- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath { /* ... */ }

#pragma mark - Override (覆盖父类的方法)

// ... 重写来自 ZOCSuperclass 的方法

#pragma mark - NSObject (覆盖 NSObject 类的方法 )

- (NSString *)description { /* ... */ }

💡 敲黑板!到这里,如果有人就是搞不明白,写这些花里胡哨的东西到底有啥用啊?请在类文件中输入键盘快捷键 Control + 6,然后等待奇迹的发生。

#warning#error 语法

当我们使用键盘快捷键 Command + B 编译项目时,编译器可能会显示很多黄色的警告(warning)或者红色的错误(error)信息。但很有可能我们比编译器更了解哪些代码中存在警告或者错误信息,只是暂时解决不了。这时候我们就可以自定义警告或者错误信息:

#warning 自定义警告信息
#error 自定义错误警告

TODO、FIXME 语法

用过 VS Code 的人很有可能安装过这两个插件:Better CommentsTODO Highlight

在 Xcode 中进行编码时,至少可以使用 5 个不同的注释标签在代码中方便地进行跳转:

// TODO:
// FIXME:
// MARK:
// ???:
// !!!:
  • TODO 注释:标记某些日后需要修正的代码、待办事项、等待日后更新或者完善的代码。
  • FIXME 注释:标记某些可能存在 Bug 的代码,以便日后修复。
  • MARK 注释:标记需要关注的代码,普通注释,与 #pragma mark 效果相同。
  • ??? 注释:当你不确定某些代码逻辑的原理,或者没看懂别人写的代码时,可以打上三个问号进行标记。
  • !!! 注释:标记需要关注的代码,通常用来标记重要的步骤、方法、功能、核心算法。

实际编程时,通过以上几个标签编写注释代码:

键盘快捷键 Control + 6 查看标记效果:

参考

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,530评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 86,403评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,120评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,770评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,758评论 5 367
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,649评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,021评论 3 398
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,675评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,931评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,659评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,751评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,410评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,004评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,969评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,042评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,493评论 2 343

推荐阅读更多精彩内容