Compilerwaarschuwing (niveau 1) CS1570

XML-opmerking over 'construct' heeft slecht gevormde XML — 'reden'

Wanneer u DocumentationFile gebruikt, moeten opmerkingen in de broncode in XML staan. Elke fout met de XML-markering genereert CS1570. Voorbeeld:

• Als u een tekenreeks doorgeeft aan een cref, zoals in een <exception> tag, moet de tekenreeks tussen dubbele aanhalingstekens worden geplaatst.

• Als u een tag gebruikt die geen afsluitende tag heeft, zoals <seealso>, moet u een schuine streep opgeven vóór de sluitende hoekige haak.

• Als u een groter dan of kleiner symbool wilt gebruiken in de tekst van de beschrijving, moet u deze vertegenwoordigen met > of <. U kunt ook CDATA gebruiken.

• Het bestands- of padkenmerk op een <include> tag ontbreekt of is onjuist gevormd.

In het volgende voorbeeld wordt CS1570 gegenereerd:

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