Ler em inglês

Partilhar via


Aviso do compilador (nível 1) CS1570

Comentário XML sobre 'construct' tem XML mal formado — 'razão'

Ao usar DocumentationFile, todos os comentários no código-fonte devem estar em XML. Qualquer erro com sua marcação XML gerará CS1570. Por exemplo:

  • Se você estiver passando uma cadeia de caracteres para um cref, como em uma marca de <exceção>, a cadeia de caracteres deverá ser colocada entre aspas duplas.

  • Se você estiver usando uma tag que não tenha uma tag de fechamento, como <seealso,> deverá especificar uma barra antes do colchete angular de fechamento.

  • Se você precisar usar um símbolo maior ou menor que no texto da descrição, você precisa representá-los com &gt; ou &lt;. Como alternativa, você pode usar CDATA.

  • O atributo file ou path em uma <tag include> estava ausente ou formado incorretamente.

O exemplo a seguir gera 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;
}