Baca dalam bahasa Inggris

Bagikan melalui


Compiler Warning (level 1) CS1570

Komentar XML pada 'konstruksi' memiliki XML yang salah bentuk — 'alasan'

Saat menggunakan DocumentationFile, komentar dalam kode sumber harus berada di XML. Kesalahan dengan markup XML Anda akan menghasilkan CS1570. Misalnya:

  • Jika Anda meneruskan string ke cref, seperti dalam <tag pengecualian>, string harus diapit dalam tanda kutip ganda.

  • Jika Anda menggunakan tag yang tidak memiliki tag penutupan, seperti <seealso>, Anda harus menentukan garis miring ke depan sebelum kurung sudut penutupan.

  • Jika Anda perlu menggunakan simbol yang lebih besar dari atau kurang dari dalam teks deskripsi, Anda perlu merepresentasikannya dengan &gt; atau &lt;. Atau, Anda dapat menggunakan CDATA.

  • Atribut file atau jalur pada tag <include> tidak ada atau salah bentuk.

sampel berikut menghasilkan 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;
}