Lire en anglais

Partager via


Avertissement du compilateur (niveau 1) CS1570

Le commentaire XML sur 'construction' contient du code XML mal rédigé — 'raison'

Lors de l’utilisation de DocumentationFile, tous les commentaires du code source doivent être au format XML. Les erreurs de balisage XML génèrent l’avertissement CS1570. Par exemple :

  • Si vous passez une chaîne à un cref, comme dans une étiquette <exception>, la chaîne doit être entourée de guillemets doubles.

  • Si vous utilisez une étiquette, qui n’a pas d’étiquette de fermeture, telle que <seealso>, vous devez spécifier une barre oblique avant le crochet angulaire fermant.

  • Si vous devez utiliser les symboles « supérieur à » et « inférieur à » dans le texte de description, vous devez les représenter ainsi : &gt; et &lt;. Vous pouvez également utiliser CDATA.

  • L’attribut de fichier ou de chemin d’une étiquette <include> était manquant ou incorrect.

L’exemple suivant génère l’erreur 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;
}