Leggere in inglese

Condividi tramite


Avviso del compilatore (livello 1) CS1570

Il commento XML in 'construct' presenta un formato XML errato - 'reason'

Quando si usa DocumentationFile, tutti i commenti nel codice sorgente devono essere in XML. Gli errori relativi al markup XML generano l'avviso CS1570. Ad esempio:

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

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

  • Per usare i simboli maggiore di o minore di nel testo della descrizione, è necessario indicarli con &gt; o &lt;. In alternativa, è possibile usare CDATA.

  • L'attributo del file o del percorso in un tag <includi> era mancante o non correttamente formato.

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