Question

我正在努力充分利用doxygen和IntelliSense，并发现XML commands在这里是一个非常好的胜利：一方面生成文档，另一方面它在完成时出现。< / p>

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

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>
};

有没有办法在XML中的成员之后以Doxygen和Visual Studio正确理解的方式编写文档，或者我应该回过头来评论前一行？

Answer 1

它并不完全漂亮，但您可以改用//!<。这样，Visual Studio不会尝试将注释解析为XML。

如链接的doxygen documentation中所述：

大多数情况下，一个人只想在其后加上简短的说明。这样做如下：

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

或

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

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

1 个答案: