11

假设我正在使用与 DOxygen/Visual Studio 兼容的注释记录成员函数，如何使用小于“<”符号而不创建编译器警告但仍保持代码库的可读性？

例如，如果我这样做：

    /// <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。我们正在使用一种对两者都适用的表格。原始问题中提到的警告来自视觉工作室而不是 Doxygen。

挖掘得更深一点，看起来不直接支持逐字记录？

4

4 回答 4

8

只需使用\<，就应该这样。 http://www.doxygen.nl/manual/commands.html#cmdlt

于 2012-09-14T14:00:37.237 回答
3

您可以使用代码 或 逐字。

于 2012-09-14T14:26:36.023 回答
2

我能找到的唯一允许将<字符内联在摘要中的东西似乎是，&lt;但即使智能感知和 doxygen 看起来不错，它在实际代码库中仍然看起来很丑......

于 2012-09-14T15:00:42.050 回答
0

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

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

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

附加信息：

XML 中的 <![CDATA[]]> 是什么意思？

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

于 2013-08-21T14:56:48.297 回答