Una documentación clara y completa es crucial en el entorno de desarrollo de software actual para garantizar el éxito del proyecto. DocFX C# e IronPDF son dos herramientas eficaces que generan documentación y mejoran la legibilidad y accesibilidad de la documentación del proyecto mientras agilizan los flujos de trabajo de documentación. Esta publicación explicará cómo combinar IronPDF, una biblioteca C# para crear documentos PDF, con DocFX, un generador de documentación API que genera documentación de referencia API. Los desarrolladores pueden producir rápidamente excelente documentación y compartirla en formato PDF utilizando estas herramientas.

Cómo utilizar DocFX

1. Instalar .NET SDK 6.0+
2. Abrir PowerShell.
3. Ejecutar el script uno por uno para instalar la biblioteca DocFX.
4. Después de la instalación, ejecutar el archivo JSON.
5. Esto abre el sitio de documentación en el puerto 8080.

Introducción a DocFX

Microsoft creó el generador de sitios estáticos de código abierto y herramienta de generación de documentación DocFX. Con la ayuda de archivos Markdown y código fuente, los desarrolladores pueden producir sitios web de documentación que lucen profesionales. DocFX es adaptable y ampliamente aplicable en una variedad de proyectos porque admite una multitud de formatos de marcado y lenguajes de programación.

Los desarrolladores pueden crear tutoriales, artículos conceptuales y referencias API en su documentación utilizando DocFX. Debido a su arquitectura adaptable, los equipos pueden personalizarlo y extenderlo para satisfacer sus requisitos únicos. DocFX también ofrece características como referencias cruzadas, plantillas editables y soporte para varios formatos de salida, incluidos HTML y Markdown. Para una descripción más detallada del funcionamiento interno y métodos de DocFX, por favor visite la Documentación de DocFX.

Cómo empezar con DocFX

Configuración de DocFX

Es bastante fácil usar DocFX. Implica agregar el SDK de DocFX utilizando el administrador de paquetes de .NET de Microsoft, NuGet. Las bibliotecas y herramientas necesarias para incorporar contenido web en sus aplicaciones usando DocFX están incluidas en este SDK.

Crear un nuevo sitio web DocFX

Crearemos un sitio web de documentación básica en su computadora local en esta fase.

• Se requiere un entendimiento básico de las operaciones de línea de comandos.
• Se requiere una versión de .NET SDK 6.0 o posterior.

Para instalar la versión más reciente de DocFX, asegúrese de tener instalado el .NET SDK, luego abra una herramienta de línea de comandos del terminal y escriba el siguiente comando:

dotnet tool update -g docfx

Para iniciar un nuevo docset, ejecute:

docfx init

docfx init

Crea un archivo JSON de todas las configuraciones. Con la ayuda de este comando, puede crear un nuevo proyecto DocFX en el directorio de trabajo actual. Para crear el docset, ejecute:

docfx docfx.json --serve

docfx docfx.json --serve

Ahora se puede previsualizar la página web en http://localhost:8080.

Guarde sus cambios. DocFX se configura utilizando el archivo de configuración JSON. Ahora, estamos usando un nuevo terminal para ejecutar este comando para reconstruir el sitio web y previsualizar sus cambios locales:

docfx docfx.json

docfx docfx.json

Características de DocFX

Flexible y ampliable

DocFX es compatible con varios formatos de marcado y lenguajes de programación, como archivos JSON, YAML y Markdown. Los equipos pueden seleccionar el formato que mejor se adapte a sus requisitos y gustos gracias a esta flexibilidad. Además, la arquitectura extensible de DocFX permite a los programadores añadir y modificar sus características a través de plugins y plantillas, satisfaciendo una variedad de necesidades de documentación.

Generación de documentación de API

DocFX es una excelente herramienta que ayuda a escribir documentación API a partir de comentarios encontrados en el código fuente. DocFX crea automáticamente documentación de referencia API, incluidas namespaces, clases, métodos, parámetros y tipos de retorno, al analizar comentarios de código en formatos ampliamente utilizados como XML y YAML. Esta característica ahorra a los desarrolladores una gran cantidad de tiempo y esfuerzo al agilizar el proceso de documentación para APIs de código.

Compatibilidad entre plataformas

Debido a que DocFX es multiplataforma, puede operar en sistemas Linux, macOS y Windows. Independientemente del sistema operativo que el equipo de desarrollo use, esta compatibilidad cruzada garantiza que la generación de documentación pueda incorporarse fácilmente en una variedad de flujos de trabajo y configuraciones de desarrollo.

Búsqueda y navegación integradas

DocFX viene con soporte integrado para navegación y búsqueda dentro de la documentación generada. El acceso rápido a información pertinente es posible gracias a la capacidad de los usuarios de buscar en la documentación temas, APIs o palabras clave con facilidad. Para mejorar aún más la usabilidad y experiencia del usuario, DocFX también crea una Tabla de Contenidos (TOC) que facilita a los usuarios navegar por la jerarquía de la documentación.

Integración de DocFX con IronPDF

Al combinar DocFX con IronPDF, los desarrolladores pueden aprovechar las ventajas de cada herramienta y mejorar su proceso de documentación. Los desarrolladores pueden asegurar una renderización consistente a través de dispositivos, crear documentación lista para estar sin conexión y facilitar el compartir y distribuir usando IronPDF para convertir la documentación HTML generada por DocFX a formato PDF. Para saber más sobre IronPDF, por favor consulte la Documentación de IronPDF.

Instalar IronPDF

• Inicie el proyecto en Visual Studio.
• Elija "Herramientas" > "Administrador de Paquetes NuGet" > "Consola del Administrador de Paquetes".
• En la consola del Administrador de Paquetes de Visual Studio, escriba el siguiente comando (corrija esta línea a un comando adecuado de instalación de paquetes):

Install-Package IronPdf

• Alternativamente, puede instalar IronPDF usando el Administrador de Paquetes NuGet para Soluciones.

• Puede seleccionar el paquete IronPDF de los resultados de búsqueda, y luego hacer clic en la opción "Instalar". Visual Studio gestionará la descarga e instalación en su nombre.

  

• NuGet instalará el paquete IronPDF junto con cualquier dependencia requerida para su proyecto.

• Después de la instalación, IronPDF puede ser utilizado en su proyecto.

Instalación a través del sitio web de NuGet

Para obtener información adicional sobre las características, compatibilidad y descargas disponibles de IronPDF, visite su página de paquete en NuGet en el sitio web de NuGet.

Utilizar DLL para instalar

Alternativamente, puede integrar directamente IronPDF en su proyecto utilizando su archivo DLL. Para descargar el archivo ZIP que contiene el DLL, haga clic en esta página de descarga de DLL. Descomprima el archivo y agregue el DLL a su proyecto.

Implementación de la lógica

La siguiente lógica está involucrada en el proceso de integración:

1. Crear Documentación con DocFX: Para comenzar, use DocFX para crear su documentación. Para generar documentación HTML, esto implica ejecutar el proceso de construcción de DocFX en el código fuente y archivos Markdown de su proyecto.
2. Usar IronPDF para Convertir Documentación HTML a PDF: Después de que la documentación HTML se haya creado, utilice IronPDF para convertirla programáticamente a formato PDF. Convertir texto HTML a documentos PDF imprimibles es fácil utilizando las características de conversión de HTML a PDF de IronPDF.
3. Automatizar el Proceso de Conversión: Use código C# o scripts para automatizar el proceso de conversión y optimizar el flujo de trabajo. Esto garantiza que la documentación pueda ser actualizada y regenerada fácilmente sin requerir intervención manual.

using IronPdf;

class Program
{
    static void Main()
    {
        // Create a new HtmlToPdf Renderer
        var Renderer = new HtmlToPdf();

        // Render the webpage as PDF
        var PDF = Renderer.RenderUrlAsPdf("http://localhost:8080/index.html");

        // Save PDF to a file
        PDF.SaveAs("output.pdf");

        // Inform the user of successful PDF creation
        Console.WriteLine("PDF generated successfully!");
        Console.ReadKey();
    }
}

using IronPdf;

class Program
{
    static void Main()
    {
        // Create a new HtmlToPdf Renderer
        var Renderer = new HtmlToPdf();

        // Render the webpage as PDF
        var PDF = Renderer.RenderUrlAsPdf("http://localhost:8080/index.html");

        // Save PDF to a file
        PDF.SaveAs("output.pdf");

        // Inform the user of successful PDF creation
        Console.WriteLine("PDF generated successfully!");
        Console.ReadKey();
    }
}

Imports IronPdf

Friend Class Program
	Shared Sub Main()
		' Create a new HtmlToPdf Renderer
		Dim Renderer = New HtmlToPdf()

		' Render the webpage as PDF
		Dim PDF = Renderer.RenderUrlAsPdf("http://localhost:8080/index.html")

		' Save PDF to a file
		PDF.SaveAs("output.pdf")

		' Inform the user of successful PDF creation
		Console.WriteLine("PDF generated successfully!")
		Console.ReadKey()
	End Sub
End Class

Imports IronPdf

Friend Class Program
	Shared Sub Main()
		' Create a new HtmlToPdf Renderer
		Dim Renderer = New HtmlToPdf()

		' Render the webpage as PDF
		Dim PDF = Renderer.RenderUrlAsPdf("http://localhost:8080/index.html")

		' Save PDF to a file
		PDF.SaveAs("output.pdf")

		' Inform the user of successful PDF creation
		Console.WriteLine("PDF generated successfully!")
		Console.ReadKey()
	End Sub
End Class

Para leer más sobre el ejemplo de código, vea esta guía de uso de ejemplo. La salida de ejecución se muestra a continuación:

Conclusión

Finalmente, los desarrolladores tienen una opción sólida para crear y diseminar excelente documentación en formato PDF al integrar DocFX con IronPDF en C#. Los desarrolladores pueden producir documentación extensa, lista para estar sin conexión y fácilmente accesible y compartida al combinar DocFX e IronPDF en las capacidades de producción de PDF para la generación de documentación. Esta integración mejora el flujo de trabajo de documentación, mejora la legibilidad y accesibilidad de la documentación del proyecto, y aumenta la probabilidad de éxito del proyecto de software.

Los desarrolladores pueden optimizar sus procedimientos de documentación, mejorar la colaboración y comunicación, y proporcionar mejores experiencias de documentación para usuarios y partes interesadas al implementar las recomendaciones en este artículo y hacer uso de las capacidades de DocFX e IronPDF.

El $999 Lite bundle incluye una licencia perpetua, un año de mantenimiento de software y una actualización a la biblioteca. IronPDF ofrece licencias gratuitas con restricciones en la redistribución y tiempo. Los usuarios pueden evaluar la solución durante el período de prueba sin tener que ver una marca de agua. Para información adicional sobre el precio y la licencia, por favor consulte los detalles de licencia de IronPDF.