Cómo recopilar artículos de TechNet

El equipo de Technet está desarrollando una nueva utilidad mediante la que poder exportar los artículos de Technet en un único documento, desde el post “Export your own TechNet book” nos explican como crear nuestro propio libro de artículos de TechNet.

En las páginas de Technet al seleccionar el modo “Lightweight” dispondremos de la opción “Print Multiple topics” desde la que podremos ir agregando artículos a nuestro libro para luego descargarlo como un solo fichero. La utilidad todavía está en pruebas así que no esperéis gran cosa, pero vale la pena para documentaciones.

Os dejo un fichero PDF de ejemplo: Herramientas de productividad.pdf

 

Documentando con Sandcastle

¿Sirve de algo esos comentarios que ponemos en el código o sirve para entretenernos con el Intellisense?

En ocasiones nos puede ser útil documentar nuestro código y distribuirlo al equipo para que todos sean conscientes de los elementos disponibles sin tener que abrir veinte proyectos.

Sandcastle nos permite crear una ayuda tipo msdn con los elementos definidos en nuestros componentes.

Para generalo nos proporcionan varias herramientas por línea de comandos, pero lo mejor es utilizar un ejemplo "SandcastleGui.exe", que nos automatiza la creación.

Seleccionamos nuestro assembly y el fichero de comentarios, el tipo de documentación y el formato.

Para generar el fichero de comentarios de nuestro componente, simplemente entramos en las propiedades del proyecto, en "Build", marcamos "Xml documentation file". Esto hará que visual studio genere un fichero xml con todos los comentarios que hayamos puesto.

Como resultado tendremos una documentación con el siguiente formato:

Si queremos crear la ayuda en ficheros tipo chm necesitaremos tener instalado “htmlhelp workshop”, que es el módulo de Microsoft para crear ficheros “chm”.