NDoc2005 – Installation & Utilisation

Présentation

La génération de la documentation sous DotNet est historiquement réalisé par NDoc (portage de JDoc de Java), mais abandonné depuis un bon moment… Chez Microsoft, un projet de Codplex libre (selon les termes de Licence de Microsoft) était utilisé en interne “SandCastle” pour les MSDN. Sont seul défaut ce situe dans la complexité d’utilisation (même si de nombreux projet de GUI existe) et surtout dans les limitations des formats de sortie(CHM & Co)...

Cependant une reprise du projet NDoc existe, on retrouve NDoc2005 (qui peut s’interfacer dans VS2005) et même NDOC3 (full compatible avec le Framework 3.x).

Pour nos besoin et sa simplicité d’utilisation nous allons utiliser NDoc2005…

Installation

Downloader les sources de la Beta de NDoc2005
NDoc2005Beta sur sourceforge

Puis déziper l’archive, ouvrir la solution et lancer une exécution.

Utilisation

Dans NDoc2005

Ouvrir votre Assembly depuis le répertoire Bin\Debug\VotreProjet.dll
Définissez le répertoire de sortie.
Puis exécuter la génération.