【问题标题】:warning CS1570: XML comment on 'myclass' has badly formed XML -- 'A name was started with an invalid character.'警告 CS1570:“myclass”上的 XML 注释 XML 格式错误——“名称以无效字符开头。”
【发布时间】:2015-06-19 17:30:12
【问题描述】:

我有一些 C# 代码使用 doxygen cmets 来处理一些方程。 VS2013应该给我一个警告信息

warning CS1570: XML comment on 'myclass' has badly formed XML -- 
'A name was started with an invalid character.'

我的 cmets 如下,“

/// \f[
/// T_{max}<30
/// \f]

我真的必须摆脱这个警告信息。最好的选择是不要更改编译选项以忽略此警告。

我应该如何解决它?感谢您的任何建议。

【问题讨论】:

    标签: c# doxygen xml-comments


    【解决方案1】:

    是的,您需要转义 &amp;lt; - 在 XML 中它是 &amp;lt;

    所以这是有效的:

    /// \f[
    /// T_{max}&lt;30
    /// \f]
    

    现在我不知道 doxygen 如何在 C# 中处理 cmets - 如果它真的想要原始表单,因为它没有将 cmets 作为 XML 处理,那么您应该在 C# 项目设置中关闭 XML 注释。 (基本上你要么需要提供有效的 XML,要么需要阻止任何东西期望它是有效的 XML。)

    【讨论】:

    • 非常感谢您的快速回复。它适用于 C# 和 doxygen。
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2020-10-08
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2015-03-23
    • 1970-01-01
    相关资源
    最近更新 更多