首页 文章

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

提问于
浏览 次
19

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的第三方文件的其他文档相关警告 .

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

xcode documentation warnings

3 回答

  • 28

    您可以使用此代码段来禁止警告：

    #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（代码段来自那里）

    回复于
  • 8

    使用cocoapods时我遇到同样的问题 .
    如果您正在使用cocoapods，并希望使pods文件中的警告静音，则可以执行以下操作：

    • 在目标的 Build Settings 中，选择 All && Levels ，然后搜索 documentation comments .

    • 然后将项目的 documentation comments 更改为 NO ，将目标的 documentation comments 更改为 YES .

    • 然后清理构建文件夹（按下命令选项Shift K），重新编译目标 . 您将从pod文件中清除 Document issue 警告，并仍然将它们用于您自己的文件 .

    • 如果您想要使自己的文件静音，请将目标的 documentation comments 保持为 NO 即可 .

    • 结果如下所示：

    enter image description here

    回复于
  • 11

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

    在您的podfile中，添加

    inhibit_all_warnings!

    删除所有警告

    要么

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

    从特定库中删除警告 .

    回复于

相关问题