Ostrzeżenie kompilatora (poziom 1) CS1570

Komentarz XML dotyczący elementu "construct" ma źle sformułowany kod XML — "reason"

W przypadku korzystania z pliku DocumentationFile wszelkie komentarze w kodzie źródłowym muszą być w formacie XML. Każdy błąd w oznaczeniu XML wygeneruje CS1570. Przykład:

• Jeśli przekazujesz ciąg do cref, na przykład w tagu <exception>, ciąg musi być ujęty w znaki podwójnego cudzysłowu.

• Jeśli używasz tagu, który nie ma tagu zamykającego, takiego jak <seealso>, musisz określić ukośnik do przodu przed nawiasem zamykającym kąta.

• Jeśli musisz użyć symbolu większości lub mniejszości w tekście opisu, musisz przedstawić je odpowiednio za pomocą > lub <. Alternatywnie można użyć CDATA.

• Brak atrybutu pliku lub ścieżki w tagu <include> lub został nieprawidłowo sformułowany.

Poniższy przykład generuje 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;
}