Que tal fanáticos de la documentación. Recientemente me han solicitado documentar cierto código desarrollado en C# con Visual Studio 2010. Me tome a la tarea de desarrollarlo.
Bueno, para iniciar les recomiendo el blog escrito por mi compañero Jack para que se familiaricen con los tags de documentación en Visual Studio.
Ahora lo siguiente que tienen que hacer es descargar Sandle Castle.
NOTA: A mi me sucedió algo curioso ya que al parecer desconfiguro algo en mi Visual Studio 2010, y lo único que tuve que hacer fue reinstalarlo (pero no confirmo que sea por la instalación de Sandle Castle).
Comencemos con abrir Visual Studio 2010:
- Abrir el código en “Visual Studio 2010”,
- En el “Explorador de soluciones” seleccionar el código con el botón secundario del ratón y dar clic en la opción “Propiedades”,
- En la ventana de “Propiedades” del proyecto seleccionar la pestaña “Generar”. En el apartado “Resultado” seleccionar la casilla “Archivo de documentación XML”,
- En el menú principal de “Visual Studio 2010” seleccionar “Generar” y después “Generar Solución”.
Ahora continuaremos abriendo Sandle Castle:
- En el menú superior seleccionamos la opción “File” y enseguida la opción “New Project”,
- En la ventana “Project Explorer” hacer clic con el botón secundario del ratón en el nodo “Documentation Sources” y seleccionar la opción “Add documentation sources…”,
- En la ventana de diálogo, seleccionar el proyecto que se desea documentar,
- En la ventana “Project Properties”, seleccionar la opción “Build”,
- Seleccionar los tipos de archivos de ayuda que se desean generar. Recomiendo seleccionar uno por uno,
- Guardar el proyecto,
- Presionar el botón “Build”,
- Es recomendable configurar otras opciones para depurar bien el archivo de salida, pero queda fuera para los fines de este blog 😀
La verdad la documentación que se genera esta bien, los invito a que lo prueben y alimenten este blog.
Saludos.
Analista/Desarrollador y cofundador de QBit Mexhico. Tecnologías utilizadas Android, Java (EJB, Servlets, Faces, Groovy & Grails, Maven, Swing), .Net (C#, VB, ASP, MVC), Delphi, Spring, Hibernate, DTSx, Oracle, T-SQL, Firebird, MySQL, MongoDB, NodeJs, ReactJs (Flux). Sistemas Operativos Mac, Ubuntu y Windows.
Estoy tratando de generar la documentación de un proyecto del tipo “ASP.NET Web Service Application” en base a lo que tengo documentado dentro del código (usando el tag summary). Toda la información que encontré para hacer lo que estoy buscando, aborda solo a los proyectos de otros tipos, activando la opción “XML Documentation File” en el menú propiedades del proyecto, el problema es que los proyectos del tipo “ASP.NET Web Service Application” no tienen esta opción en el menú propiedades.
Quisiera saber si hay algún procedimiento o programa para generar esta documentación de forma automática en este tipo de proyecto. La documentación en lo posible debería estar en formato web.