成员和 XML 命令之后的 Doxygen 文档答案

【问题标题】：Doxygen documentation after members and XML commands成员和 XML 命令之后的 Doxygen 文档
【发布时间】：2014-08-13 04:35:03
【问题描述】：

我试图充分利用 doxygen 和 IntelliSense，并发现 XML commands 在这里是一个很好的胜利：一方面生成文档，另一方面在完成过程中出现。

其中一个问题是成员之后的内联文档。

doxygen manual 仅提及在成员之后获取文档的一种方式：///<。不幸的是，它与 Visual Studio 的冲突，如下所示：

enum
{
    A, ///< Doxygen understands this, but IntelliSense is oblivious to it.
    B, ///  <summary>IntelliSense understands this, but Doxygen applies it to the wrong member.</summary>
    C, ///< <summary>Doxygen understand this, but IntelliSense considers it to be invalid XML.</summary>
};

有没有办法以 Doxygen 和 Visual Studio 都可以正确理解的方式在 XML 中的成员之后编写文档，还是我应该退回对前一行的评论？

【问题讨论】：

标签： visual-studio intellisense doxygen xml-comments

【解决方案1】：

它不是很漂亮，但您可以使用 //!< 代替。这样，Visual Studio 就不会尝试将注释解析为 XML。

正如链接中提到的doxygen documentation：

大多数情况下，人们只想在成员后面加上简短的描述。这样做如下：

int var; //!< Brief description after the member

或

int var; ///< Brief description after the member

【讨论】：