不是 Doxygen 尾随评论答案

【问题标题】：Not a Doxygen trailing comment不是 Doxygen 尾随评论
【发布时间】：2016-10-08 05:58:22
【问题描述】：

我正在使用 Xcode 使用 OpenCV 库创建一个项目。我得到一个编译错误说

不是 Doxygen 尾随注释

在 core.hpp 和 opencv 框架中包含的许多其他资源中。（编者：我的 opencv 框架是从互联网的某个地方得到的，需要将它绑定到我的项目中）。

我该如何自救？

【问题讨论】：

欢迎来到 S.O.请详细说明您的问题，以便我们更好地为您提供帮助。
我也明白了。您可能可以忽略这一点。但是，必须有某种方法可以消除此消息。

标签： xcode opencv

【解决方案1】：

您可以转到构建设置并搜索文档评论并设置为No。 Doxygen 只是一种格式，对于您不是所有者的代码，您可以跳过它。

【讨论】：

谢谢！这会给你一个赏金:-)顺便说一句，“可以”，而不是“不能”
为您不拥有/无法更改的代码在本地禁用警告是 OP 情况的 100% 正确答案。但这是一个有效的警告，因为尾随 Doxygen cmets 开始，例如//!the relevant bit of the Doxygen documentation 并修复代码。
不是每个人都使用 doxygen。 // 是合法评论。

【解决方案2】：

作为临时解决方案：

通过单击黄色三角形并按回车键来消除大部分警告，这将进行一些自动更正。

对于三角形中带有感叹号的单个注释，请删除一些注释。

这基本上只会改变 opencv 源代码中的一些 cmets。因为我的是本地副本而不是 git clone ，这很好。我想基本上opencv的人需要解决这个问题。但是，如果知道 Swift 中的一些编译器选项可以关闭这些警告，那就太好了。

【讨论】：

【解决方案3】：

这为我解决了这个问题，抑制了第三方库标题中的警告only。只需用这些pragmas 包装有问题的标头#includes：

#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdocumentation"
#include <opencv2/core/core.hpp>
#include <opencv2/highgui/highgui.hpp>
#pragma clang diagnostic pop

您可以替换或添加其他要忽略的警告标志。这是来自 Konchog 的提示和 Vladimir Grigorov 的超级有用的回答 here 的组合。

【讨论】：