Leer en inglés

Compartir a través de


Advertencia del compilador (nivel 1) CS1570

El comentario XML de 'construct' tiene código XML con formato incorrecto: 'reason'

Al usar DocumentationFile, los comentarios del código fuente deben estar en XML. Cualquier error con el formato XML generará la advertencia CS1570. Por ejemplo:

  • Si pasa una cadena a un elemento cref, como en una etiqueta <exception>, la cadena debe incluirse entre comillas dobles.

  • Si usa una etiqueta que no tenga una etiqueta de cierre, como <seealso>, debe especificar una barra diagonal antes del corchete angular de cierre.

  • Si necesita usar símbolo de mayor que o menor que en el texto de la descripción, deberá representarlos con &gt; o &lt;. Como alternativa, puede usar CDATA.

  • El atributo de ruta de acceso o archivo de una etiqueta <include> faltaba o estaba mal formado.

El ejemplo siguiente genera la advertencia 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;
}