Compilerwarnung (Stufe 1) CS1570

  • Artikel

Aktualisiert: November 2007

Fehlermeldung

Der XML-Kommentar für "Konstrukt" enthält falsch formatierten XML-Code – "Ursache"
XML comment on 'construct' has badly formed XML ù 'reason'

Wenn /doc verwendet wird, müssen alle Kommentare im Quellcode in XML geschrieben sein. Fehler mit der XML-Markierung generieren CS1570. Beispiel:

  • Wenn Sie eine Zeichenfolge an cref übergeben (z. B. in einem <exception>-Tag), muss die Zeichenfolge in doppelten Anführungszeichen stehen.

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

  • Wenn Sie im Beschreibungstext ein Größer-als- oder Kleiner-als-Zeichen verwenden müssen, müssen Sie diese Zeichen mit &gt; oder &lt; darstellen.

  • Das Datei- oder Pfadattribut für ein <include>-Tag fehlte oder war nicht ordnungsgemäß formatiert.

Im folgenden Beispiel wird CS1570 generiert:

// 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 ()
      {
      }
   }
}