¿Cómo has conseguido realizar la documentación al estilo MSDN?
Es muy sencillo, te explico, de forma resumida:
La imagen de arriba es puro Html compilado con la herramienta
HTML Help Compiler (
hhc.exe) del paquete
Microsoft HTML Help Workshop que puedes descargar gratuitamente desde MSDN;
los archivos de la estructura de archivos o filesystem (index.html, style.css, image.jpg, etc) son comprimidos y empaquetados en un archivo de ayuda con formato
.chm (
Microsoft Compiled HTML Help File).
La razón de que tenga un aspecto visual parecido a
MSDN, es por que hoy en día existen muchas herramientas que además de ofrecer plantillas Html de ese estilo, automatizan dicha tarea de documentación Html para APIs, extrayendo los datos de las fuentee de documentación de una solución .Net mediante el uso de
Reflection para los miembros no documentados mnualmente (ej:
Int32), y de la documentación existente en los archivos de documentación XML generados por la solución de VS para los miembros que hayan sido documentados manualmente, claro está.
La herramienta que utilicé para compilar el ejemplo en la imagen de arriba, es la opción favorita que se puede encontrar dentro del software open-source:
➢
Sandcastle Help File BuilderDe hecho, prefiero utilizar ese programa antes que cualquier software comercial craqueado, y sabes que de eso tengo un montón para .Net, jaja, pero
SandCastle aun siendo gratuito es insuperable.
Por otro lado, para documentar la UI de una aplicación, sus características etc, es preferible usar herramientas más especializadas en esa tarea, cómo por ejemplo
Help&Manual,
Helpinator, o
Dr. Explain, cada una de ellas tiene funcionalidades alucinantes, sobre todo la "captura" que realiza
Dr. Explain sobre los elementos de una GUI (pruébalo, en serio).
WinCHM también es útil, pero es muy simplón.
Para compilar en formato
.chm, el cual es el formato de documentación offline más común, pues cómo ya he mencionado necesitarás disponer del compiler (
hhc.exe) que viene incluido en el paquete
Microsoft HTML Help Workshop:
➢
Microsoft HTML Help Downloads(no recuerdo si el
SandCastle incluye el
hhc.exe, pero igualmente para utilizar otras herramientas de este tipo lo necesitarás por que no lo suelen incluir por defecto, es un requisito adicional)
Si deseas documentar la API en formato
HxS entonces necesitarás el compiler del paquete
Microsoft Help 2 pero no es descargable desde la MSDN, viene incluido en la instalación de VS2008, y está considerado cómo formato obsoleto, vaya, que no vale la pena interesarse por él.
También puedes compilar en formato
.mshc para visualizarlo con la herramienta
Microsoft Help Viewer que viene incluida en la instalación de VS.
EDITO: Ah, se me olvidó comentarte que además con la extensión
GhostDoc puedes generar los archivos htm al estilo
MSDN con el comando "
Preview Comment" (pero no compilar un
.chm).
Saludos!