iOS开发:#pragma代码整理与警告处理

#pragma

其作用是:整理代码和防止编译器警告。
作为预处理指令,#pragma在编译时进行计算,但它并不像如 #ifdef...#endif 之类的宏,#pragma 的使用不会改变代码的运行轨迹。反过来思考更加通俗易懂:注释是不会影响项目的运行顺序


一、整理代码

有一定经验的iOS开发程序猿,一般会在自己的代码中使用【#pragma mark - message】将代码分成一个个逻辑区块,方便自己和同事查找和阅读代码。如果没有使用#pragma来整理代码没,也没有做好代码分离,这对程序员来说简直就是一场灾难。
下面,我在这里对#pragma mark 如何使用及如何帮助我们快出查找和阅读代码做一些简单地说明:

@implementation ViewController

- (id)init {
  ...
}

#pragma mark - UIViewController

- (void)viewDidLoad {
  ...
}

#pragma mark - IBAction

- (IBAction)cancel:(id)sender {
  ...
}

#pragma mark - UITableViewDataSource

- (NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger)section {
  ...
}

#pragma mark - UITableViewDelegate

- (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath {
  ...
}

在@implementation中使用#pragma mark来将代码分割成一个个逻辑区块。这些逻辑区块可以使代码更具有可读性。当你点击功能栏的方法那一区块的时候就会出现如下的列表。ps:使用 【#pragma mark - 】可以增加一行水平分割线


图一

二、屏蔽警告处理

对于【#pragma】消除警告处理的用法估计用的人就比较少了。对这一块比较了解的人,一般对代码都有一定的强迫症,想尽可能的消除掉警告。下面我对这一块的使用进行详细的说明:
相信很多人都会在代码里面导入一些第三方库,目前很多的第三方库都带有很多编译器警告。如果你不想看到这些警告或者已经确认没有问题,但它仍然报警告的时候,这时候Clang提供了一个非常方便的方法来处理这一问题。

[1] 特定代码警告处理

通过使用【#pragma clang diagnostic push/pop】,你可以告诉编译器仅仅为某一特定部分的代码(最初的诊断设置在最后的pop被恢复)忽视特定警告。其步骤如下:

#pragma clang diagnostic push
#pragma clang diagnostic ignored "-相关命令"
    // 你自己的代码
#pragma clang diagnostic pop

下面例举几个常见的使用:

1、方法弃用警告
#pragma clang diagnostic push   
#pragma clang diagnostic ignored "-Wincompatible-pointer-types"  
   //  
#pragma clang diagnostic pop
2、 不兼容指针类型
    #pragma clang diagnostic push   
    #pragma clang diagnostic ignored "-Wincompatible-pointer-types"   
    //  
    #pragma clang diagnostic pop  
3、循环引用
    // completionBlock is manually nilled out in AFURLConnectionOperation to break the retain cycle.  
    #pragma clang diagnostic push  
    #pragma clang diagnostic ignored "-Warc-retain-cycles"  
        self.completionBlock = ^ {  
            ...  
        };  
    #pragma clang diagnostic pop  
4、未使用变量
    // completionBlock is manually nilled out in AFURLConnectionOperation to break the retain cycle.  
    #pragma clang diagnostic push  
    #pragma clang diagnostic ignored "-Warc-retain-cycles"  
        self.completionBlock = ^ {  
            ...  
        };  
    #pragma clang diagnostic pop  
5、未使用default
#pragma clang diagnostic push   
#pragma clang diagnostic ignored "-Wunused-variable"   
  int a;   
#pragma clang diagnostic pop  

在push的时候开启,在pop的时候结束,其中在ignored开始后忽略报警。

[2] 整个应用警告处理

在项目的building setting里面搜索【Other Warning Flags】,我们可以在里面,添加想要消除的警告。当然在这里设置,对项目所有文件都起作用,具体使用步骤如下图:


图二

[3] 针对文件类或整个应用

一般情况下,有一些想要忽略的警告(注意不是致命错误!)可以在文件顶端加入,其代码姿势如下:

#pragma clang diagnostic ignored "-W警告名"

比较常见的如:

//方法弃用
#pragma clang diagnostic ignored "-Wdeprecated-declarations"         
//使用位置变量
#pragma clang diagnostic ignored "-Wunused-variable"   

那么上面里例举的那些警告名怎么获取呢,请看下图:

图三
图四

获取到警告名称后,直接复制到对应的方法即可。

在这里我整理了一个【ZMWarmingIgnored.h】文件类,包含了绝大部分的警告名,放在xxx.pch文件中调用,可以消除大部分的警告,欢迎大家使用:
点我马上去下载


三、补充:警告的使用

如果我们追求代码的严苛和谨慎我们可以添加一些我们平常没有使用的警告。也可以在Other C Flags 中加入【-Wall】(开启大部分警告),-Wextra,【-Weverything】(开启全部警告)来添加警告,当然在调试过程中不推荐,不然你试试就知道了😜😜😜
这里面的警告有许多是编译器开发人员所使用的警告,但是同时也能让我们的代码更加清晰,规范!推荐代码release的阶段最好开启其他警告!

最后我们可以在项目中使用

#warning this is a warning

添加一个警告,提醒我们需要注意的地方,甚至我们可以使用

#error This is a error

来添加一个严重警告,提醒我们还有一些重要的事没有做完,比如在编写第三方库的时候还需要添加其他库。
我们手动添加严重警告,会比在注释中添加说明要醒目的很多!

参考链接

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

推荐阅读更多精彩内容