我如何代表一个'<'我的 XML 文档中的字符?
我在这里看到了关于 SO 的各种问题,涉及 Microsoft 的 XML 文档标签 ,但我在添加一些示例代码时遇到了麻烦:
/// <summary>Return the oldest acceptable timestamp for a data packet.</summary>
/// <example>
/// if( GetOldestValidResultTime() < lastResultTime )
/// {
/// Console::WriteLine("Results are too old");
/// }
/// </example>
/// <returns>The timestamp (the Milliseconds field from a raw result) of the oldest acceptable data item given the timestamp in the latest result in the internal buffer.</returns>
long GetOldestValidResultTime();
这给了我:
DataProcessor.h(154) : warning C4635: XML document comment applied to 'MyApp.DataProcessor.GetOldestValidResultTime': badly-formed XML: Only one top level element is allowed in an XML document.
除了使用 <
之外,还有什么办法可以解决这个问题吗?如果您正在阅读源代码,这会使示例更难以理解直接与 DOxygen 输出相反(例如)? ..或者 <
代码是这里唯一的选择吗?
[编辑] 我已经尝试了建议的 CDATA 块,但它似乎只适用于单行:
/// <example><![CDATA[ test < 5; ]]></example>
/// <example>
/// <![CDATA[ test < 5; ]]>
/// </example>
..但不适用于实际上可能构成可读示例的多行注释:
/// <example><![CDATA[
/// test < 5;
/// ]]> </example>
[ Edit2] 尝试了 pierrre 的建议,即从最后两个语句前面删除 \\,这可预见地失败了:
/// <example><![CDATA[
test < 5;
]]> </example>
给出:
error C2143: syntax error : missing ';' before '<'
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(1)
使用 CDATA 块。
Use a CDATA block.