禁用＆＃34;文档评论＆＃34;所选文件的警告

Question

Xcode能够检查文档注释问题，并在某些内容不正确时报告警告。例如，我使用CocoaPods将Facebook SDK添加到我的项目中。在文件FBError.h中的某个位置，有以下代码：

/*!
 @typedef NS_ENUM (NSInteger, FBErrorCategory)

 @abstract Indicates the Facebook SDK classification for the error

 @discussion
 */

请注意，@discussion参数为空，Xcode会相应地生成警告：

  

将空段传递给'@discussion'命令

但是，Facebook SDK并不是我添加到项目中的唯一库，而且“问题”选项卡中充满了来自我安装的Pod的第三方文件的其他文档相关警告。

我想知道如何抑制这些文件的这种警告。

Answer 1

您可以使用此代码段来取消警告：

#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdocumentation"

#import <YourHeader.h>

#pragma clang diagnostic pop

有关详细信息，请参阅此cocoapod-issue：https://github.com/CocoaPods/CocoaPods/issues/1481（代码段来自那里）

Answer 2

使用cocoapods时我遇到同样的问题 如果您正在使用cocoapods，并希望将pods文件中的警告静音，您可以这样做：

1. 在目标Build Settings中，选择All＆amp;＆amp; Levels，然后搜索documentation comments。
2. 然后将您的项目documentation comments更改为NO，将目标documentation comments更改为YES。
3. 然后清理构建文件夹（按Command + Option + Shift + K），重新编译目标。您将从pod文件中清除Document issue警告，并仍然将它们用于您自己的文件。
4. 如果您想要静音自己的文件，请将目标documentation comments保持为NO即可。
5. 结果如下：

Answer 3

如何忽略来自cocoapods添加的库的警告？

在您的podfile中，添加

inhibit_all_warnings!

删除所有警告

或者

pod 'Facebook-iOS-SDK', :inhibit_warnings => true

删除特定库中的警告。