Exportar (0) Imprimir
Expandir todo

Agregar comentarios en código C#

Visual Studio .NET 2003

Para agregar y ver comentarios fácilmente dentro de la estructura del código C#, utilice los informes Web de comentario de código. Los comentarios y las etiquetas XML mostradas en un informe Web de comentario de código están precedidos por la sintaxis de comentario ///. Normalmente, los comentarios se especifican antes de los tipos definidos por el usuario (como una clase, una estructura o una interfaz), miembros (como un campo, un evento, una propiedad o un método) o una declaración de espacio de nombres.

Para agregar comentarios en código C#

  1. Abra un archivo .cs en un editor.
  2. Cambie a la vista Código.
  3. Escriba /// seguido de cualquier cadena de texto o etiqueta XML. Si especifica /// en la línea antes de la definición, el editor crea una plantilla de un comentario de documentación y rellena los parámetros y otra información.

    Por ejemplo, en el archivo class1.cs antes de public Class1() puede especificar lo siguiente:

    ///<summary>
    ///summary description
    ///</summary>
    ///<remarks>
    ///This is a test.
    ///</remarks>
    

En la estructura de código para Class1, la información mostrada dentro de las etiquetas <summary></summary> aparece en la columna Descripción. La información mostrada dentro de las etiquetas <remarks></remarks> aparece en la página detallada para class1 en la sección Comentarios. Para obtener un listado de las etiquetas XML admitidas, vea Crear informes de código.

Vea también

Ver la estructura del código con comentarios | Generar páginas Web de comentarios (Cuadro de diálogo) | Crear informes de código | Etiquetas para comentarios de documentación

Mostrar:
© 2014 Microsoft