Discussion :

[olivier34]

Bonjour,

Visual Studio 2008 Pro possède la fonction de documentation automatique du code au format XML, qui est appelée, lorsque l’on saisit "///" avant la définition d’une classe, d’une méthode…

Une cartouche de commentaire est alors insérée, comme par exemple :

Code :

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

1
2
3
4
5
        /// <summary>
        ///
        /// </summary>
        /// <param name="array"> </param>
        /// <returns> </returns>

Est-il possible de définir ce qu’il sera inséré (pour chacun des objets sur lequel ce raccourci s’applique) ?

J’ai parcouru le répertoire d’installation de Visual mais sans succès. Je sais qu’il y a aussi les "snippets" mais je crains que la documentation ne rentre pas dans ce cadre là.

Olivier.

[Louis-Guillaume Morand]

quel en serait l'intérêt??

c'est pas juste du texte affiché, c'est surtout les outils derrière comme NDoc et SandCastle qui sont importants. Or si tu changes la structure de la doc, ceux-ci ne marcheront plus et à part pour l'autocompletion, la doc ne sera pas plus utile qu'une simple ligne de commentaire.

[olivier34]

quel en serait l'intérêt??

En fait, l'intérêt est d'utiliser de nouvelles commandes de documentation (d'ailleurs pas forcément custom, mais de la spécification C#), autres que celles pré-établies dans Visual Studio.

Bien sûr, derrière il y a post-processing avec des outils de génération de documentation.

Et donc, sais-tu comment faire ?

Olivier.

[Louis-Guillaume Morand]

Et donc, sais-tu comment faire ?

Olivier.

bien sûr il te suffit de modifier la macro qui se nomme InsertDocComments. avec ce mot clé, google te dira comment l'éditer

indice: n'appuie pas sur alt+F8

[olivier34]

YES ! C'est exactement cela.

Merci beaucoup.

Olivier.

[obitskater]

Bonjour, je suis tombé sur ce post car j'avais le même besoin qu'Olivier34.
Et c'est sûr il est bien utile.

J'ai bien réussi à modifier la procédure InsertDocComments, pour ajouter les champs que je souhaite ajouter dans les balises de commantaires, mais rien ne se passe de nouveau quand je tape les 3 slash (///) au-dessus d'une classe, méthode ou autre... J'ai toujours le même template, à savoir

/// <summary>
///
/// </summary>
/// <returns></returns>

Une suggestion?

Comment as tu-fait pour que ça marche pour toi?

[olivier34]

Bonjour,

Je n'ai pas encore fait ma customisation.
Je cherchais simplement à voir si c'était possible et comment.

Olivier.

[olivier34]

Bonjour obitskater,

J'ai essayé de modifier la macro InsertDocComments.

Mais sans succès... pas de changement sur le comportement lors de la frappe des "///"... d'où je pense que c'est EN DUR !

Olivier.