live documenter
v2.1.53
¡No dejes que los comentarios se oculten en tu código fuente! Léelo, búscalo y publícalo con Live Documenter. Documentación para .NET simplificada.
Live Documenter es un conjunto de aplicaciones y bibliotecas que permiten la visualización en vivo y la generación automática de documentación a partir de código .NET y archivos de comentarios xml. Conozca qué es Live Documenter desde nuestra página de inicio y descargue la última versión.
¡Vea la documentación en vivo y actualizada!
Crea hermosa documentación estática.
O utilice la biblioteca API para integrarla en sus propios proyectos.
Live Documenter es una aplicación de escritorio, una utilidad de consola y una biblioteca API diseñada para hacer que su código .NET y sus comentarios sean más legibles y estén más disponibles. ¡Liberémoslos de los límites del xml escondido en su código fuente y démosles un buen uso!
Comience descargando la última versión y leyendo la guía de inicio rápido.
La aplicación de escritorio permite abrir proyectos, soluciones o bibliotecas de Visual Studio y generar documentación para ellos a partir de los archivos de comentarios XML en vivo. Si se realizan cambios en el código base, estos se reflejan en la aplicación cuando se reconstruye el proyecto.
También proporciona una interfaz agradable para exportar documentación, leerla e imprimirla.
La aplicación exportadora es útil para integrar la generación de documentación a los procesos existentes; como sus scripts de compilación o la creación de documentación ad-hoc.
Una DLL a la que los proyectos pueden hacer referencia para generar documentación automáticamente en tiempo de ejecución. Los detalles de la API y cómo usarla se pueden encontrar en la documentación.
Esto solo funcionará en Windows por el momento, se está trabajando para transferir a netstandard y hacer que todo, excepto la aplicación de escritorio, sea multiplataforma en .NET Core.
Se proporciona un archivo zip de la última versión. Para instalar, descargue el archivo, descomprímalo y ejecútelo desde los directorios.
Requisitos
SDK de .NET Core 3.1
Se trabajó en el código más reciente en Visual Studio 2019 y varios de los proyectos se transfirieron a bibliotecas netstandard y utilizan el último formato de archivo csproj.
Avíseme si hay algún problema al compilar desde la fuente para poder resolverlo.
Se agradece toda ayuda. Hay un sitio de documentación asociado que siempre se puede mejorar.
Si desea participar en el proyecto, eche un vistazo a los números actuales. Tome nota de su interés, obtenga la última versión y cree una solicitud de extracción cuando esté listo para fusionar los cambios.
Además, simplemente proporcionar comentarios a través de problemas de GitHub ayuda a garantizar que el proyecto se haga más estable y se mejore constantemente.
