更新:2007 年 11 月

错误消息

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

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

  • 如果向 cref 传递字符串(如在 <exception> 标记中),字符串必须用双引号引起来。

  • 如果使用标记(如没有结束标记的 <seealso>),必须在右尖括号的前面指定正斜杠 (/)。

  • 如果需要在说明文本中使用大于号或小于号,需要用 &gt;&lt; 表示它们。

  • <include> 标记上缺少文件或路径属性,或者它们的格式不正确。

下面的示例生成 CS1570:

 复制代码
// CS1570.cs
// compile with: /W:1
namespace ns
{
   // the following line generates CS1570
   /// <summary> returns true if < 5 </summary>
   // try this instead
   // /// <summary> returns true if &lt;5 </summary>

   public class MyClass
   {
      public static void Main ()
      {
      }
   }
}