Avviso del compilatore (livello 1) CS1570

Aggiornamento: novembre 2007

Messaggio di errore

Il commento XML in 'costrutto' presenta un formato XML errato - 'motivo'.
XML comment on 'construct' has badly formed XML ù 'reason'

Quando si utilizza /doc, i commenti nel codice sorgente devono avere il formato XML. Gli errori relativi a codice XML generano l'avviso CS1570. Ad esempio:

• Se si passa una stringa a un cref, ad esempio in un tag <exception>, è necessario che tale stringa sia racchiusa tra virgolette doppie.

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

• Per utilizzare i simboli maggiore di o minore di nel testo della descrizione, è necessario indicarli con &gt; o &lt;.

• L'attributo del percorso o del file in un tag <include> è assente o ha un formato non corretto.

Il seguente codice di esempio genera l'avviso CS1570:

// CS1570.cs
// compile with: /W:1
namespace ns
{
   // the following line generates CS1570
   /// <summary> returns true if < 5 </summary>
   // try this instead
   // /// <summary> returns true if &lt;5 </summary>

   public class MyClass
   {
      public static void Main ()
      {
      }
   }
}