Freigeben über

Compilerwarnung (Stufe 1) CS1570

  • Artikel

Der XML-Kommentar für 'construct' enthält ungültigen XML-Code — 'reason'

Bei Verwendung von DocumentationFile müssen alle Kommentare im Quellcode im XML-Format sein. Fehler mit dem XML-Markup generieren CS1570. Beispiel:

  • Wenn Sie eine Zeichenfolge an cref übergeben, z. B. in einem <exception>-Tag, muss die Zeichenfolge in doppelte Anführungszeichen eingeschlossen werden.

  • Wenn Sie ein Tag verwenden, das kein schließendes Tag aufweist, z. B. <seealso>, müssen Sie einen Schrägstrich vor der schließenden spitzen Klammer einfügen.

  • Wenn Sie im Text der Beschreibung ein Größer-als- oder Kleiner-als-Zeichen verwenden möchten, müssen Sie dieses mit &gt; bzw. &lt;darstellen. Alternativ können Sie CDATA verwenden.

  • Das file- oder path-Attribut für ein <include>-Tag fehlte oder wurde falsch formatiert.

Im folgenden Beispiel wird CS1570 generiert:

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;
}