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

'Yapılandırma' üzerindeki XML açıklaması hatalı biçimlendirilmiş XML içeriyor — 'neden'

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:

  • Eğer bir <exception> etiketi gibi bir durumda cref'e bir dize geçiriyorsanız, dize çift tırnak içine alınmalıdır.

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

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

  • Bir <include> etiket üzerindeki 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;
}