Compartir a través de

Advertencia del compilador (nivel 1) CS1570

  • Artículo

Actualización: noviembre 2007

Mensaje de error

El comentario XML en 'construcción' tiene código XML con formato incorrecto — 'causa'
XML comment on 'construct' has badly formed XML ù 'reason'

Al utilizar /doc, los comentarios del código fuente deben crearse en XML. Cualquier error con el formato XML generará la advertencia CS1570. Por ejemplo:

  • Si se pasa una cadena a cref, como en la etiqueta <exception>, la cadena debe ir entre comillas.

  • Si se utiliza una etiqueta, como <seealso>, que no tiene una etiqueta de cierre, se debe especificar una barra (/) antes del corchete angular de cierre.

  • Si se necesita utilizar un símbolo mayor que o menor que en el texto de la descripción, deberá representarse como &gt; o &lt;.

  • El atributo de archivo o ruta de acceso de una etiqueta <include> falta o no está correctamente formado.

El código siguiente genera la advertencia CS1570:

// CS1570.cs
// compile with: /W:1
namespace ns
{
   // the following line generates CS1570
   /// <summary> returns true if < 5 </summary>
   // try this instead
   // /// <summary> returns true if &lt;5 </summary>

   public class MyClass
   {
      public static void Main ()
      {
      }
   }
}