İngilizce dilinde oku

Aracılığıyla paylaş


Derleyici Uyarısı (düzey 1) CS1570

'yapı' üzerindeki XML açıklaması hatalı biçimlendirilmiş XML'ye sahip — 'reason'

DocumentationFile kullanılırken, kaynak koddaki açıklamaların XML içinde olması gerekir. XML işaretlemenizle ilgili herhangi bir hata CS1570 oluşturur. Örneğin:

  • Cref'e özel durum> etiketi gibi bir <dize geçiriyorsanız, dize çift tırnak içine alınmalıdır.

  • Seealso> gibi <bir kapanış etiketi olmayan bir etiket kullanıyorsanız, kapanış açılı ayracından önce eğik çizgi belirtmeniz gerekir.

  • Açıklama metninde büyüktür veya küçüktür simgesi kullanmanız gerekiyorsa, bunları veya &lt;ile &gt; temsil etmeniz gerekir. Alternatif olarak, CDATA kullanabilirsiniz.

  • Ekleme <> etiketindeki dosya veya yol özniteliği eksik veya yanlış biçimlendirilmiş.

Aşağıdaki örnek CS1570 oluşturur:

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