Partager via

Avertissement du compilateur (niveau 1) CS1570

  • Article

Mise à jour : novembre 2007

Message d'erreur

Le commentaire XML sur 'construction' contient du code XML mal rédigé — 'raison'
XML comment on 'construct' has badly formed XML ù 'reason'

Lors de l'utilisation de /doc, les commentaires contenus dans le code source doivent être en XML. Une erreur dans le balisage XML génère l'avertissement CS1570. Par exemple :

  • Si vous passez une chaîne à cref, par exemple dans une balise <exception>, la chaîne doit être en guillemets doubles.

  • Si vous utilisez une balise, par exemple <seealso>, qui n'a pas de balise de fermeture, vous devez spécifier une barre oblique avant le crochet pointu de fin.

  • Si vous avez besoin d'utiliser un symbole supérieur à ou inférieur à dans la description du texte, vous devez les représenter sous la forme &gt; ou &lt;.

  • L'attribut file ou path d'une balise <include> est manquant ou incorrect.

L'exemple suivant génère l'avertissement 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 ()
      {
      }
   }
}