成员和XML命令后的Doxygen文档

Question

我试图从doxygen和IntelliSense中获得最大收益，并发现XML命令在这里是一个不错的选择：一方面生成文档，另一方面在完成时显示文档。

吸引人的地方之一是成员之后的内联文档。

该doxygen的说明书只提到一个拥有成员后的文档的方式：///<。不幸的是，它与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成员之后编写文档，还是我应该退一步评论前一行？

Answer 1

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

正如链接的doxygen 文档中提到的：

大多数情况下，人们只想在成员后面添加一个简短的描述。这是按如下方式完成的：

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

或者

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