如何在Doxygen注释中包含“<”？
如何在Doxygen注释中包含“<”？
提问于 2012-09-14 21:57:53
假设我正在使用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。
再深入一点，看起来逐字不是直接的supported吗？
回答 4
Stack Overflow用户
回答已采纳
发布于 2012-09-14 22:00:37
只需使用\<，应该就是这样。http://www.doxygen.nl/manual/commands.html#cmdlt
Stack Overflow用户
发布于 2012-09-14 23:00:42
我能找到的唯一允许在摘要中内联<字符的似乎是<，但在实际的代码库中它看起来仍然很丑陋，即使智能感知和doxygen看起来很好……
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/12426073
复制相关文章
相似问题