04/08/2020

C# : Documentation technique

playlist : Visual Studio 2019 et C#
catégories : C# 

description :
Comment générer automatiquement une documentation technique sous Visual Studio.
Le fichier généré étant au format XML, il est plus pratique d'utiliser un outil pour obtenir un autre format plus lisible, comme un site HTML.
L'outil utilisé dans cette vidéo est Sandcastle, téléchargeable ici :
https://github.com/EWSoftware/SHFB/releases

00:00 : configuration du projet pour créer la doc technique
00:48 : ajout des commentaires normalisés
03:53 : génération de la doc au format xml
04:45 : téléchargement et installation de SandCastle
09:37 : création du projet sous SandCastle
11:58 : obtention du site de la doc technique