警告 CS1570：XML 'myclass' 的评论格式错误 XML -- 'A name was started with an invalid character.'

Question

我有一些 C# 代码使用 doxygen 对某些方程进行注释。 VS2013 应该给我一个警告信息

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

我的评论如下，“<”引起了这个警告信息。

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

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

我该如何解决？感谢您的任何建议。

Answer 1

是的，您需要转义 < - 在 XML 中是 <。

所以这是有效的：

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

现在我不知道 doxygen 如何在 C# 中处理注释 - 如果它真的想要原始形式，因为它没有像 XML 那样处理注释，那么你应该关闭 XML 注释在 C# 项目设置中。（基本上你要么需要提供有效的 XML，要么你需要阻止任何期望它有效的东西 XML。）

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