为Doxygen处理编写的代码通常会有这样的行。
int myVariable; ///< description of myVariable
然而,当Visual Studio(例如VS 2015)使用这些Doxygen注释准备的代码时,其myVariable
的工具提示信息将显示
XML comment contains invalid XML: Whitespace is not allowed at this location.
问题似乎是"///"后面紧接着出现了"<"。Visual Studio似乎将其解释为XML内容的信号(格式不正确)。然而,这个组合与"<"一起出现,以向Doxygen发出信号,表明注释适用于行上的前一项,而不是下一项。
假设我们谈论的是已经遵循这个Doxygen约定的现有代码体。它已经在很多地方这样写了。
是否有一种方法可以调整、教授或设置Visual Studio,使其将这些注释视为前一项的正常文档注释,从而使它们显示在这些项的工具提示中?
Doxygen有不同的注释样式(请参阅手册中关于"特殊注释块"的部分,在本例中是关于"将文档放在成员之后"的段落)。在这里我们看到了可能性:
int var; /**< Detailed description after the member */
or
int var; //!< Detailed description after the member
//!<
or
int var; ///< Detailed description after the member
在这种情况下,我们可以从///<
切换到//!<