如何协调 Visual Studio 注释期望与具有 Doxygen 注释的代码？答案

【问题标题】：How to reconcile Visual Studio comment expectations with code having Doxygen comments?如何协调 Visual Studio 注释期望与具有 Doxygen 注释的代码？
【发布时间】：2016-08-06 14:50:03
【问题描述】：

为 Doxygen 处理编写的代码有这样的行是正常的。

int myVariable; ///< description of myVariable

但是，当 Visual Studio（例如 VS 2015）处理使用这些 Doxygen cmets 准备的代码时，将显示 myVariable 的工具提示信息

XML comment contains invalid XML: Whitespace is not allowed at this location.

问题似乎是紧跟在“///”之后的“

假设我们正在讨论已经遵循此 Doxygen 约定的现有代码体。很多地方都是这样写的。

有没有办法调整或教授或设置 Visual Studio，以便它将此类 cmets 视为前面项目的正常文档 cmets，以便它们出现在这些项目的工具提示中？

【问题讨论】：

VS2017RC4中同样的问题...
解决方案是将///< 替换为//!< cmets 吗？不过会有点工作。
@albert 谢谢你的建议！请将其添加为建议的答案/解决方案。从技术上讲，这不是我希望通过调整 Visual Studio 获得的简单解决方案。但是，由于没有人提出任何这样的答案，因此您的观察值得作为替代解决方法得到认可。

标签： xml visual-studio comments tooltip doxygen

【解决方案1】：

Doxygen 有不同的注释样式（参见手册中关于“特殊注释块”的部分，在这种情况下是关于“将文档放在成员之后”的段落。在这里我们看到了可能性：

int var; /**< Detailed description after the member */
or
int var; //!< Detailed description after the member
//!<
or
int var; ///< Detailed description after the member

在这种情况下，我们可以从///< 切换到//!<

【讨论】：

尽管在我的问题中我希望有一种简单的方法来调整 Visual Studio 本身以解决问题，但从未有人提出过这样的解决方案。在这种情况下，这种替代解决方法是已提出的最有用的建议。值得庆幸的是，可以使用 Visual Studio 的 Replace in Files 将许多情况下的 ///
然而这根本不明智，尤其是在又过了 3 年之后。通过 "//!
@ripfreeworld 请解释您的评论的含义、您测试的内容以及使用的 doxygen 版本。
@albert 我有 Doxygen 的 1.9.1 版本，我的意思是在 Visual Studio (2019) 中使用 //!< 并不完美，因为 !< 将保留在工具提示信息的开头。
@ripfreeworld 你现在提到VS（2019）这里有什么关系？也许你应该用一个完整的例子和你所看到的来打开一个新问题。