Ler em inglês

Compartilhar via


Aviso do compilador (nível 1) CS1570

Comentário XML sobre o "constructo" tem XML mal formado – "motivo"

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

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

  • Se você estiver usando uma marcação que não tem fechamento, tal como <seealso>, será necessário especificar uma barra "/" antes do colchete de fechamento.

  • Se você precisar usar os símbolos "maior que" ou "menor que" no texto da descrição, será necessário representá-los com &gt; ou &lt;. Como alternativa, você pode usar CDATA.

  • O atributo de arquivo ou caminho em uma marcação <include> estava ausente ou foi formatado incorretamente.

O seguinte exemplo gera o erro CS1570:

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