閱讀英文

共用方式為


編譯器警告 (層級 1) CS1570

'construct' 上 XML 註解的 'reason' XML 格式錯誤

使用 DocumentationFile 時,原始程式碼中的任何註解都必須為 XML 格式。 XML 標記的任何錯誤都會產生 CS1570。 例如:

  • 如果您是將字串傳遞給 cref (例如在 <exception> 標記中),則必須以雙引號括住字串。

  • 如果您是使用沒有結尾標記的標記 (例如 <seealso>),則必須在右角括號前面指定正斜線。

  • 如果您需要在描述文字中使用大於或小於符號,則需要使用 &gt;&lt;代表它們。 或者,您可以使用 CDATA。

  • <include> 標記上的檔案或路徑屬性遺漏或格式不正確。

下列範例會產生 CS1570:

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;
}