computacion

¿QUÉ HAY EN ESTE TEMA?
• Agregar Documentación en tus líneas de código con XML Comments
• El uso de GhostDoc con Visual Studio Add-In para generar automáticamente los comentarios XML.
• Producir documentación independiente de comentarios XML con Sandcastle
La documentación es crítica, y a menudo es pasado por alto, es una característica del proceso de desarrollo. Sin documentación, otrosprogramadores, evaluadores de código y administradores de proyectos se les complicaría el analizar los efectos y el impacto del código. Nosotros mismos tenemos problemas incluso con nuestro propio código cuando se torna complejo, y tener una buena documentación interna puede ayudar en el proceso de desarrollo.
Los comentarios XML son una buena manera de proporcionar la documentación interna parael código sin tener que pasar por el proceso de crear y mantener manualmente un documento separado. En cambio, a medida que escribe el código, se incluyen los metadatos en la parte superior de cada definición para explicar el propósito de su código. Cuando la información se ha incluido en el código, puede ser consumido por Visual Studio para proporcionar un buscador de objetos e información deIntelliSense.
GhostDoc es un add-in gratis para Visual Studio que automáticamente puede insertar un bloque de comentario XML para una clase o miembro.
Sandcastle es un conjunto de herramientas que actúan como un compilador de documentación. se pueden utilizar estas herramientas para generar fácilmente documentación independiente de Microsoft esto es en base a los comentarios añadido a su código.Los comentarios en línea se resaltan en color verde.
C # admite comentarios de una sola línea y bloques de comentario. una sola línea de comentario se denota por / / al comienzo del comentario. Los comentarios de bloque típicamente abarcar varias líneas y se abren por / * y cerrado por * /.

Los comentarios XML son comentarios especiales que se incluyen en el código. Cuando el proyecto pasa porel proceso de generación, Visual Studio puede incluir opcionalmente la creación de un archivo XML basado en estos comentarios estos comentarios también sirven para suministrar información acerca de los tipos definidos por el usuario, tales como clases y los miembros individuales de una clase definida por el usuario (o no), incluidos los eventos, funciones y propiedades.

AGREGANDO XMLCOMMENTS.
XML comments se añaden inmediatamente antes de la definición de la propiedad, el método o la clase a la que están asociados. Visual Studio agrega automáticamente un bloque de comentario XML al escribir el código de acceso directo / / /.

TAGS DEFINIDOS DE XML COMMENTS.
Los XML COMMENTS pueden contener cualquier combinación de etiquetas XML y HTML. Visual Studio realiza el procesamientoespecial en un determinado conjunto de etiquetas predefinidas,
El procesador de comentarios XML de Visual Studio 2012 reconoce una serie de etiquetas predefinidas y automáticamente formatos de manera apropiada. Si usamos el compilador de documento Sandcastle nos proporciona soporte para una serie de etiquetas adicionales, y se puede complementar.

Indica que el texto adjunto debe tener elformato de código, en lugar de texto normal. Se utiliza para el código que se incluye en un bloque de texto normal. La estructura de es simple, con cualquier texto que aparezca entre las etiquetas de apertura y cierre están marcados para el formato en el estilo de código.


Si la cantidad de texto en la documentación que necesita para formatear el código es más que una frase dentro de un bloquede texto normal, puede utilizar la etiqueta en lugar de . Esta etiqueta representa todo dentro de ella como un código, pero es una etiqueta a nivel de bloque, en lugar de una etiqueta de nivel caracter. La sintaxis de esta etiqueta es una simple apertura y cierre de la etiqueta con el texto para ser formateado en el interior, como se muestra aquí:

puede ser embebido dentro de cualquier...