Avviso del compilatore (livello 1) CS1570

Commento XML su 'construct' ha un formato XML non valido - 'reason'

Quando si usa DocumentationFile, tutti i commenti nel codice sorgente devono essere in FORMATO XML. Qualsiasi errore con il markup XML genererà CS1570. Per esempio:

  • Se si passa una stringa a un cref, ad esempio in un <exception> tag, la stringa deve essere racchiusa tra virgolette doppie.

  • Se si usa un tag che non dispone di un tag di chiusura, ad esempio <seealso>, è necessario specificare una barre oblique prima della parentesi angolare di chiusura.

  • Se è necessario usare un simbolo maggiore o minore di nel testo della descrizione, è necessario rappresentarli con &gt; o &lt;. In alternativa, è possibile usare CDATA.

  • L'attributo di file o percorso in un <include> tag è mancante o non corretto.

L'esempio seguente genera 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;
}