docfx C# (Comment ça marche pour les développeurs)

Introduction

Une documentation claire et complète est essentielle dans l'environnement de développement de logiciels d'aujourd'hui pour garantir la réussite du projet. DocFx C# et IronPDF sont deux outils efficaces qui permettent de générer de la documentation et d'améliorer la lisibilité et l'accessibilité de la documentation des projets tout en rationalisant les flux de travail de documentation. Ce billet explique comment combiner IronPDF, une bibliothèque C# pour la création de documents PDF, avec DocFX, un générateur de documentation d'API qui génère une documentation de référence sur les API. Les développeurs peuvent rapidement produire une excellente documentation et la partager au format PDF en utilisant ces outils.

Comment utiliser DocFX

1. Installer le SDK .NET 6.0+

2. Ouvrez le PowerShell.

3. Exécutez le script un par un et installez la bibliothèque DocFX.

4. Après l'installation, exécutez le fichier JSON.

5. Ce qui ouvre le site de documentation sur le port 8080.

Introduction à DocFX

Microsoft a créé le générateur de sites statiques et l'outil de génération de documentation DocFX. Grâce aux fichiers Markdown et au code source, les développeurs peuvent produire des sites web de documentation d'aspect professionnel. DocFX est adaptable et largement applicable à une variété de projets car il prend en charge une multitude de formats de balisage et de langages de programmation.

Les développeurs peuvent créer des tutoriels, des articles conceptuels et des références API dans leur documentation en utilisant DocFX. Grâce à son architecture adaptable, les équipes peuvent le personnaliser et l'étendre pour répondre à leurs besoins spécifiques. DocFX offre également des fonctionnalités telles que les références croisées, les modèles modifiables et la prise en charge de plusieurs formats de sortie, notamment HTML et Markdown. Pour une description plus détaillée du fonctionnement interne et des méthodes de DocFX, veuillez visiter la documentation DocFX.

Démarrer avec DocFX

Configuration de DocFX

Il est très facile d'utiliser DocFX. Il s'agit d'ajouter le SDK DocFX à l'aide de NuGet, le gestionnaire de paquets .NET de Microsoft. Les bibliothèques et les outils nécessaires pour incorporer du contenu web dans vos applications à l'aide de DocFX sont inclus dans ce SDK.

Créer un nouveau site web DocFX

Au cours de cette phase, nous créerons un site web de documentation de base sur votre ordinateur local.

• Une connaissance de base des opérations en ligne de commande est nécessaire.

• Une version de .NET SDK 6.0 ou ultérieure est requise.

  Pour installer la version la plus récente de DocFX, assurez-vous que le SDK .NET est installé, puis ouvrez un outil de ligne de commande terminal et tapez la commande suivante :

dotnet tool update -g docfx

dotnet tool update -g docfx

Pour démarrer un nouveau docset, exécutez :

docfx init

docfx init

Il crée un fichier JSON contenant toutes les configurations. Cette commande permet de créer un nouveau projet DocFX dans le répertoire de travail actuel. Pour créer le docset, exécutez :

docfx docfx.json --serve

docfx docfx.json --serve

La page web peut maintenant être vue en aperçu sur http://localhost:8080.

Sauvegardez vos changements, DocFX est configuré en utilisant le fichier de configuration JSON. Nous utilisons maintenant un nouveau terminal pour exécuter cette commande afin de reconstruire le site web et de prévisualiser vos changements locaux :

docfx docfx.json

docfx docfx.json

Caractéristiques de DocFX

Flexible et extensible

DocFX est compatible avec plusieurs formats de balisage et langages de programmation, tels que les fichiers JSON, YAML et Markdown. Grâce à cette flexibilité, les équipes peuvent choisir le format qui correspond le mieux à leurs besoins et à leurs goûts. En outre, l'architecture extensible de DocFX permet aux programmeurs d'ajouter et de modifier ses fonctionnalités par le biais de plugins et de modèles, répondant ainsi à une grande variété de besoins en matière de documentation.

Génération de la documentation de l'API

DocFX est un excellent outil qui permet d'écrire la documentation de l'API à partir des commentaires trouvés dans le code source. DocFX crée automatiquement la documentation de référence de l'API, y compris les espaces de noms, les classes, les méthodes, les paramètres et les types de retour, en analysant les commentaires de code dans des formats largement utilisés tels que XML et YAML. Cette fonctionnalité permet aux développeurs d'économiser beaucoup de temps et d'efforts en rationalisant le processus de documentation des API de code.

Compatibilité multiplateforme

DocFX étant multiplateforme, il peut fonctionner sous Linux, macOS et Windows. Indépendamment du système d'exploitation utilisé par l'équipe de développement, cette compatibilité multiplateforme garantit que la génération de documentation peut être facilement incorporée dans une variété de flux de travail et de paramètres de développement.

Recherche et navigation intégrées

DocFX est livré avec un support intégré pour la navigation et la recherche dans la documentation générée. L'accès rapide aux informations pertinentes est rendu possible par la capacité des utilisateurs à rechercher facilement dans la documentation des sujets, des API ou des mots-clés. Pour améliorer encore l'utilisabilité et l'expérience utilisateur, DocFX crée également une Table des Matières (TOC) qui facilite la navigation des utilisateurs dans la hiérarchie de la documentation.

Intégration de DocFX avec IronPDF

En combinant DocFX et IronPDF, les développeurs peuvent utiliser les avantages de chaque outil et améliorer leur processus de documentation. Les développeurs peuvent garantir un rendu cohérent sur tous les appareils, créer une documentation prête à être mise hors ligne et faciliter le partage et la distribution en utilisant IronPDF pour convertir au format PDF la documentation HTML générée par DocFX. Pour en savoir plus sur IronPDF, veuillez consulter la Documentation IronPDF.

Installer IronPDF

• Démarrer le projet Visual Studio.
• Choisissez "Outils" > "NuGet Package Manager" > "Console du gestionnaire de paquets".
• Dans la console Visual Studio Package Manager, tapez la commande suivante :

Install-Package IronPdf

• Vous pouvez également installer IronPDF à l'aide de NuGet Package Manager for Solutions.

• Vous pouvez sélectionner le paquet IronPDF dans les résultats de la recherche, puis cliquer sur l'option "Installer". Visual Studio se chargera du téléchargement et de l'installation en votre nom.

  

• NuGet installera le paquetage IronPDF ainsi que toutes les dépendances nécessaires à votre projet.
• Après l'installation, IronPDF peut être utilisé pour votre projet.

Installation via le site Web de NuGet

Pour plus d'informations sur les fonctionnalités, la compatibilité et les téléchargements disponibles d'IronPDF, visitez sa page de package NuGet sur le site NuGet.

Utiliser la DLL pour l'installation

Alternativement, vous pouvez intégrer directement IronPDF dans votre projet en utilisant son fichier DLL. Pour télécharger le fichier ZIP contenant la DLL, cliquez sur cette page de téléchargement de la DLL. Décompressez le fichier et ajoutez la DLL à votre projet.

Mise en œuvre de la logique

La logique suivante intervient dans le processus d'intégration :

1. Créer de la documentation avec DocFX : Pour commencer, utilisez DocFX pour créer votre documentation. Pour générer une documentation HTML, il faut exécuter le processus de construction de DocFX sur le code source et les fichiers Markdown de votre projet.

2. Utilisez IronPDF pour convertir la documentation HTML en PDF : Une fois que la documentation HTML est créée, utilisez IronPDF pour la convertir de manière programmée au format PDF. Convertir du texte HTML en documents PDF imprimables est facile grâce aux fonctions de conversion HTML-PDF d'IronPDF.

3. Automatisez le processus de conversion : Utilisez du code C# ou des scripts pour automatiser le processus de conversion afin d'optimiser le flux de travail. Cela garantit que, si une intervention manuelle est nécessaire, la documentation peut être facilement mise à jour et régénérée.

using IronPdf;
        var Renderer = new IronPdf.HtmlToPdf();
        var PDF = Renderer.RenderUrlAsPdf("http://localhost:8080/index.html");
        // Save PDF to file
        PDF.SaveAs("output.pdf");
        Console.WriteLine("PDF generated successfully!");
        Console.ReadKey();

using IronPdf;
        var Renderer = new IronPdf.HtmlToPdf();
        var PDF = Renderer.RenderUrlAsPdf("http://localhost:8080/index.html");
        // Save PDF to file
        PDF.SaveAs("output.pdf");
        Console.WriteLine("PDF generated successfully!");
        Console.ReadKey();

Imports IronPdf
		Private Renderer = New IronPdf.HtmlToPdf()
		Private PDF = Renderer.RenderUrlAsPdf("http://localhost:8080/index.html")
		' Save PDF to file
		PDF.SaveAs("output.pdf")
		Console.WriteLine("PDF generated successfully!")
		Console.ReadKey()

Pour en savoir plus sur l'exemple de code, consultez ce guide d'utilisation de l'exemple. Le résultat de l'exécution est présenté ci-dessous :

Conclusion

Enfin, les développeurs disposent d'une option solide pour créer et diffuser une excellente documentation au format PDF en intégrant DocFX à IronPDF en C#. Les développeurs peuvent produire une documentation complète, prête à être mise hors ligne, facilement accessible et partagée, en combinant les capacités de production PDF de DocFX et IronPDF pour la génération de documentation. Les projets logiciels sont plus souvent couronnés de succès grâce à cette intégration, qui améliore également le flux de documentation et rend la documentation du projet plus facile à lire et plus accessible.

Les développeurs peuvent optimiser leurs procédures de documentation, améliorer le travail d'équipe et la communication, et offrir de meilleures expériences de documentation aux utilisateurs et aux parties prenantes en mettant en œuvre les recommandations de cet article et en utilisant les capacités de DocFX et d'IronPDF.

Le bundle $749 Lite comprend une licence perpétuelle, un an de maintenance logicielle et une mise à niveau de la bibliothèque. IronPDF propose des licences gratuites avec des restrictions de redistribution et de temps. Les utilisateurs peuvent évaluer la solution pendant la période d'essai sans voir de filigrane. Pour plus d'informations sur le prix et la licence, veuillez consulter les détails de la licence d'IronPDF. Allez sur cette page des bibliothèques Iron Software pour plus d'informations sur les bibliothèques Iron Software.