logo标签列表

如何在Doxygen注释中包含'<'？

visual-studio-2008doxygendocumentation-generation
13
假设我正在使用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生成的文档中仍然可读的方式来避免这种情况？
[编辑]
我开始觉得这更多是与Visual Studio相关，而不是Doxygen。我们正在使用一个应该适用于两者的表单。原问题中提到的警告来自Visual Studio而不是Doxygen。
深入挖掘一下，看起来verbatim不能直接支持？
4个回答
8
1
有没有办法在不降低可读性的情况下完成它？在这个简单的例子中，情况还不算太糟，但是如果（比如）你把它作为方程的一部分，斜杠看起来就像除号... - Jon Cage
1
使用@符号是\的替代方案。虽然看起来并不好，但不容易与除号混淆。 - risingDarkness
2
这里有Doxygen中的公式（http://www.stack.nl/~dimitri/doxygen/formulas.html）。我从未使用过它们，但似乎仍需要转义“<”。 - risingDarkness
2
我认为你对DOxygen的公式是正确的，但我找不到任何方法使MS XML文档理解“<”字符，即使我用“\”或“@”符号转义它。唯一接近的是“<”，但在代码库中看起来很糟糕。 - Jon Cage
3
...但是这必须是一个完整的块，而不是与<summary> </summary>块内联，对吧？即 /// <summary>确保x是<verbatim><</verbatim>y </summary> 是不起作用的... - Jon Cage
2

我找到的唯一允许在摘要中内联放置 < 字符的方法似乎是使用 &lt;，但即使智能感知和doxygen看起来还好，在实际代码库中它仍然看起来很丑...

0
有没有人有一个完整的例子，演示如何在Doxygen块中使用CDATA？上面的例子对我不起作用。 - Leonardo
网页内容由stack overflow 提供, 点击上面的
可以查看英文原文，
原文链接