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