Discussion :

[Contrec]

Bnjour,

Je voulais savoir comment generer a partir de Visual Studio la documentation du code.

A chaque methode ou attribut que je decare, j'attribue les balises de code, par exemple :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
        /// <summary>
        /// Occurs when clicking on a TreeNode, sets the current TreeNode to Selected TreeNode and Initializes appropriate menus.
        /// </summary>
        private void Tree_NodeMouseClick(object sender, TreeNodeMouseClickEventArgs e)
        {
            SelectedTreeNode = e.Node;
            if (e.Button == MouseButtons.Right)
            {
                if (e.Node.IsSelected)
                {
                    e.Node.ContextMenuStrip = new ContextMenuStrip();
 
                    InitializeTreeMenus(e.Node, e);
                }
            }
        }

Je voulais savoir comment me servir de ces balises pour creer une documentation.

Merci d'avance

[bouvda]

Bonjour,

sur MSDN :

Pour générer un fichier de documentation XML pour un projet Visual C#

1. Un projet étant sélectionné dans l'Explorateur de solutions, cliquez dans le menu Projet sur Propriétés.
2. Cliquez sur l'onglet Générer.
3. Sur la page Générer, sélectionnez Fichier de documentation XML. Par défaut, le fichier est créé sous le chemin de sortie spécifié, par exemple, « bin\Debug\Nomprojet.XML ».

Ensuite il y a des outils comme Sandcastle pour reprendre ce fichier XML et en faire une doc.

Il y a plus de détails sur les balises toujours sur MSDN :
http://msdn2.microsoft.com/fr-fr/lib...ax(VS.80).aspx

[dev01]

et un article sur dvp : http://vincentlaine.developpez.com/tuto/dotnet/comdoc/

[SaumonAgile]

Pour écrire plus facilement la documentation, tu peux utiliser GhostDoc. Cet outil peut générer la documentation automatiquement pour certaines méthodes en utilisant des règles et la documentation des classes parents le cas échéant.

[Contrec]

Merci pour les infos !

[NeraOne]

Encore une dernière :
NDoc existe (en version alpha) pour le framework 2.0 !
http://www.kynosarges.de/misc/NDoc2-Alpha3u.zip

Possibilité de générer de la Doc MSDN, CHM, XML, Help2(?) et Intellisense !

Bien qu'en version alpha, elle fonctionne très bien et la doc est super agréable a consulter !
++
Antoine