Číst v angličtině

Sdílet prostřednictvím


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

Komentář XML ke konstruktoru má špatně vytvořený KÓD 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. Příklad:

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

  • Pokud používáte značku, která nemá uzavírací značku, například <seealso>, musíte před pravou závorkou zadat lomítko.

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

  • Atribut souboru nebo cesty u <značky include> 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;
}