Question

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

int myVariable; ///< description of myVariable

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

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

问题似乎是＆＃34;＆lt;＆＃34;紧接着＆＃34; ///＆＃34;。这似乎被Visual Studio解释为信令（格式不正确）的XML内容。但是，这种组合与＆＃34;＆lt;＆＃34;向Doxygen发出信号，表示评论适用于该行的前一项，而不是下一项。

假设我们正在讨论已遵循此Doxygen约定的现有代码体。它已经在很多地方以这种方式编写。

有没有办法调整或教授或设置Visual Studio，以便将这些注释视为正常记录前一项的注释，以便它们出现在这些项的工具提示中？

Answer 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注释期望与具有Doxygen注释的代码进行协调？

1 个答案: