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

  发布于 2023-01-07 12:58

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

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

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

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

      然后将项目更改documentation commentsNO,将目标更改documentation commentsYES.

      然后清理构建文件夹(按Command + Option + Shift + K),重新编译目标Document issue.您将从pod文件中清除警告,并仍然将它们用于您自己的文件.

      如果你想保持沉默自己的文件为好,保持你的目标的documentation commentsNO会做的伎俩.

      结果将如下所示:

    在此输入图像描述

    2023-01-07 12:59 回答
  • 如何忽略来自cocoapods添加的库的警告?

    在您的podfile中,添加

    inhibit_all_warnings!
    

    删除所有警告

    要么

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

    从特定库中删除警告.

    2023-01-07 13:01 回答
  • 您可以使用此代码段来禁止警告:

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

    2023-01-07 13:01 回答
撰写答案
今天,你开发时遇到什么问题呢?
立即提问
热门标签
PHP1.CN | 中国最专业的PHP中文社区 | PNG素材下载 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有