英語で読む

次の方法で共有


コンパイラの警告 (レベル 1) CS1570

'construct' の XML コメントの XML 形式が正しくありません - 'reason'

DocumentationFile を使用する場合、ソース コード内のコメントは XML で記述する必要があります。 XML マークアップにエラーがあると、CS1570 が生成されます。 次に例を示します。

  • <exception> タグなどで文字列を cref に渡す場合は、文字列を二重引用符で囲む必要があります。

  • 終了タグのない <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;
}