使用英语阅读

通过


编译器警告(等级 1)CS1570

“construct”上的 XML 注释出现 XML 格式错误 —“reason”

当使用 DocumentationFile 时,源代码中的任何注释必须为 XML 格式。 XML 标记的任何错误将生成 CS1570。 例如:

  • 如果要传递一个字符串到 cref,例如,在<异常>标记中,字符串必须括在双引号内。

  • 如果正在使用没有结尾标记的标记(如<另请参阅>),必须在右尖括号的前面指定一个正斜杠。

  • 如果你需要在说明文本使用大于或小于符号,你需要用 &gt;&lt;来表示它们。 或者,你可使用 CDATA。

  • <包括>标记上的文件或路径特性缺失或格式不正确。

以下示例生成 CS1570:

C#
public static class CompareFive
{
    // the following line generates CS1570
    /// <summary> returns true if < 5 </summary>
    // try one of the following instead
    // /// <summary> returns true if &lt; 5 </summary>
    // /// <summary><![CDATA[ returns true if < 5 ]]></summary>
    public static bool LessThanFive(int x) => x < 5;
}