Cour utiliser la documentation automatique sous VB.NET, tutoriel & guide de travaux pratiques en pdf.
Installation de NDoc
Téléchargement
Il faut avant tout télécharger le fichier d’installation depuis le site officiel :
Télécharger NDoc
La dernière version release au moment de l’écriture de cet article est la version 1.2 (cela peut changer à l’avenir).
Installation
L’installation est similaire à celle de VBCommenter, on doit juste lancer l’exécutable téléchargé.
Il va décompresser automatiquement le fichier MSI qu’il contient :
A ce moment une alerte envoyée par Windows, signale que le fichier MSI n’est pas signé, vous n’en tenez pas compte et cliquez sur OUI
On arrive donc à l’exécution du fichier MSI, et on clique sur ‘Next’
Maintenant on doit définir le répertoire d’installation de l’application et si on autorise à tout le monde de l’exécuter ou seulement le compte qui lance l’installation
Utilisation
Maintenant NDoc est installé sur la machine, on peut lancer celui-ci en cliquant sur :
- Demarrer > Programme > NDoc
- Projet DotNetSysInfo – Sur DotNet Project (FR)
Utilisation de NDoc
Lors de la compilation de notre Projet, nous avons obtenu le fichier XML de commentaires dans le répertoire où se trouvent les fichiers binaires du projet.
Ce fichier XML est accompagné d’un fichier de Log (VBCommenterLog.txt) qui liste l’ensemble des fichiers scannés où se trouvaient les balises et préfixes recherchés.
On va donc dans NDoc référencer le fichier SLN de notre solution Visual Studio.NET et associer la DLL avec le fichier XML. Voyons comment faire.