Upozornění kompilátoru (úroveň 1) CS1570

Komentář XML na 'konstrukt' má špatně vytvořený XML – 'reason'

Při použití souboru DocumentationFile musí být všechny komentáře ve zdrojovém kódu ve formátu XML. Jakákoli chyba s kódem XML vygeneruje CS1570. Například:

• Pokud předáváte řetězec do cref, například ve <exception> značce, musí být řetězec uzavřen do dvojitých uvozovek.

• Pokud používáte tag, který nemá uzavírací tag, jako například <seealso>, musíte před uzavírací hranatou závorku napsat lomítko.

• Pokud potřebujete v textu popisu použít symbol větší než nebo menší než, je nutné je znázornit pomocí > nebo <. Případně můžete použít CDATA.

• Atribut souboru nebo cesty u <include> značky nebyl nalezen nebo nesprávně vytvořen.

Následující ukázka vygeneruje 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;
}