live documenter
v2.1.53
Ne laissez pas les commentaires se cacher dans votre code source ! Lisez-le, recherchez-le et publiez-le avec Live Documenter. La documentation pour .NET simplifiée.
Live Documenter est une suite d'applications et de bibliothèques qui permettent la visualisation en direct et la génération automatique de documentation à partir de code .NET et de fichiers de commentaires XML. Découvrez ce qu'est Live Documenter sur notre page d'accueil et téléchargez la dernière version.
Consultez la documentation en direct et à jour !
Créez une belle documentation statique.
Ou utilisez la bibliothèque API pour l'intégrer à vos propres projets.
Le Live Documenter est une application de bureau, un utilitaire de console et une bibliothèque API conçus pour rendre votre code et vos commentaires .NET plus lisibles et plus disponibles. Libérons-les des limites du XML enfermé dans votre code source et mettons-les à profit !
Commencez par télécharger la dernière version et lisez le guide de démarrage rapide.
L'application de bureau permet d'ouvrir des projets, des solutions ou des bibliothèques de Visual Studio et de générer en direct une documentation correspondante à partir des fichiers de commentaires XML. Si des modifications sont apportées à la base de code, elles sont reflétées dans l'application lorsque le projet est reconstruit.
Il fournit également une interface agréable pour exporter, lire et imprimer de la documentation.
L'application d'exportation est utile pour intégrer la génération de documentation aux processus existants ; comme vos scripts de build ou la création de documentation ad hoc.
Une DLL qui peut être référencée par les projets pour générer automatiquement la documentation au moment de l'exécution. Les détails de l'API et comment l'utiliser peuvent être trouvés dans la documentation.
Cela ne fonctionnera que sous Windows pour le moment, des travaux sont en cours pour transférer vers netstandard et pour que tout, sauf l'application de bureau, soit multiplateforme sur .NET Core.
Un fichier zip de la dernière version est fourni. Pour installer, téléchargez le fichier, décompressez et exécutez à partir des répertoires.
Exigences
Kit de développement logiciel .NET Core 3.1
Le dernier code a été travaillé dans Visual Studio 2019 et plusieurs projets ont été transférés vers des bibliothèques netstandard et utilisent le dernier format de fichier csproj.
S'il vous plaît laissez-moi savoir s'il y a des problèmes liés à la construction à partir des sources afin que je puisse les résoudre.
Toute aide est appréciée. Il existe un site de documentation associé qui peut toujours être amélioré.
Si vous souhaitez vous impliquer dans le projet, n'hésitez pas à consulter les problématiques actuelles. Notez votre intérêt, obtenez la dernière version et créez une pull request lorsque vous êtes prêt à fusionner les modifications.
De plus, le simple fait de fournir des commentaires via les problèmes GitHub permet de garantir que le projet est rendu plus stable et constamment amélioré.
