Question

假设我正在使用DOxygen / Visual studio兼容评论记录成员函数，我怎样才能使用小于'＆lt;'符号没有创建编译器警告但仍保持代码库中的可读性？

例如，如果我这样做：

    /// <summary>
    /// Verifies x < y
    /// </summary>
    bool VerifyIsLessThan(float x, float y);

编译器说：

1>c:\MyProject\VerificationLib.h(246) : warning C4635: XML document comment applied to 'VerificationLib.VerifyIsLessThan(System.Single,System.Single)': badly-formed XML: Whitespace is not allowed at this location.

有没有办法逃脱这种方式，使其在代码库和Doxygen生成的文档中仍然可读？

[编辑]

我开始认为这更多地与视觉工作室方面有关，而不是Doxygen。我们正在使用应该为两者工作的表单。原始问题中提到的警告来自visual studio而非Doxygen。

深入挖掘看起来像逐字不是supported？

Answer 1

只需使用\<即可。 http://www.doxygen.nl/manual/commands.html#cmdlt

Answer 2

您可以使用code或verbatim。

Answer 3

我能找到的唯一允许<字符在摘要中内联的内容似乎是<但在实际代码库中它仍然看起来很难看，即使intellisense和doxygen看起来很好。 ..

Answer 4

您也可以将评论放在CDATA块中，如下所示：

<![CDATA[ Verifies x < y ]]>

我不知道你是否真的认为这更容易阅读，但它有助于避免Jon Cage指出的问题，其中\可能被误解为分裂符号，或其他任何东西。

其他信息：

What does <![CDATA[]]> in XML mean?

http://forums.asp.net/t/1007641.aspx/1

我怎样才能包含'＆lt;'在Doxygen评论？

4 个答案: