Advertencia del compilador (nivel 1) CS1570

El comentario XML en 'construct' tiene un formato XML incorrecto: 'reason'

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

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

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

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

  • Falta el atributo file o path en una <include> etiqueta o se ha formado incorrectamente.

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