禁用选定文件的“文档注释”警告

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 的 3rd 方文件的其他文档相关警告。

我想知道如何禁止对这些文件发出这种警告。

Answer 1

您可以使用这个 sn-p 来抑制警告：

#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（sn-p 来自那里）

Answer 2

我在使用 cocoapods 时遇到了同样的问题。
如果您正在使用 cocoapods，并且想要消除 pods 文件中的警告，您可以这样做：

1. 在目标的Build Settings 中，选择All && Levels，然后搜索documentation comments。
2. 然后将项目的documentation comments 更改为NO，将目标的documentation comments 更改为YES。
3. 然后清理构建 floder（按 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

从特定库中删除警告。