Sandcastle, genera y presenta la documentación XML de tu código.

 

sandcastlelogo_jpg En estos días he estado trabajando parcialmente en un proyecto de desarrollo de una API para un CMS, de tal forma que podamos extender y automatizar ciertas funcionalidades desde aplicaciones .Net como ASP.NET, Silverlight o Windows Client.

Como una forma de ayudarme a organizar el código y a cualquiera que use mi código, agregué comentarios XML a mis clases en C#, tratando de poner la descripción de los métodos al estilo de las clases de .Net. Esta interesante característica de documentación ofrece ayuda contextual en línea cuando alguien usa un método dentro de Visual Studio  (a manera de tool tips). El compilador de C# es capaz de extraer estos comentarios y generar un archivo XML usado por Visual Studio, pero también puede ser usado por otras aplicaciones como el caso de Sandcastle que se encarga de leer este tipo de archivos XML y aplicar reflexión al proyecto relacionado para extraer metadatos adicionales para generar una documentación completa al estilo MSDN.

Sandcastle es de Microsoft, gratis y de código abierto, pueden descargarlo desde el sitio en CodePlex. Adicionalmente les recomiendo descargar el Sandcastle Help File Builder que es la interfaz gráfica para la aplicación Sandcastle. Su forma de uso es simple y al estilo del extrañado NDoc, les dejo algunas capturas de pantalla de esta herramienta y cómo se ve la documentación generada:

sc1 sc2 Imagen 1

Responder

Introduce tus datos o haz clic en un icono para iniciar sesión:

Logo de WordPress.com

Estás comentando usando tu cuenta de WordPress.com. Cerrar sesión / Cambiar )

Imagen de Twitter

Estás comentando usando tu cuenta de Twitter. Cerrar sesión / Cambiar )

Foto de Facebook

Estás comentando usando tu cuenta de Facebook. Cerrar sesión / Cambiar )

Google+ photo

Estás comentando usando tu cuenta de Google+. Cerrar sesión / Cambiar )

Conectando a %s

A %d blogueros les gusta esto: