[C# 2.0/VS2005] Comment personnaliser la génération des commentaires ?

**sirex007** · 27/07/2006, 17h53

Bonjour,

J'aimerai savoir si quelqu'un sait comment modifier les commentaires générés automatiquement lorsqu'on saisi "///" avant un nom de fonction par exemple.

Je vous montre ce que j'entends :
Par défaut dans visual studio, quand on tape "///" on a ca :

Code :

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

1
2
3
            /// <summary>
            /// 
            /// </summary>

Je voudrais savoir, si ce texte est modifiable, car j'aimerai bien que, lorsque je tape "///" j'ai quelque chose de la sorte :

Code :

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

1
2
3
4
5
6
7
8
            /// <summary>
            /// 
            /// </summary>
            /// <remarks>
            /// </remarks>
            /// <history>
            ///     [LUDOVIC]   27/07/2006  Created
            /// </history>

Histoire de gagner un peu de temps et de ne pas avoir à saisir 15000 fois les même balises.

PS : Je fais bien la différence avec les templates qui servent à la création d'un document, ca je m'en sert déjà pour préformater mes fichiers vierges... J'aimerai justement aller plus loin dans cet optique.

Cordialement,

**m-mas** · 28/07/2006, 10h58

je ne pense pas que c'est possible, mais il y a déja l'intellisense qui t'aide beaucoup !!! il suffit d'utiliser les raccourcis clavier ...

**sirex007** · 01/08/2006, 15h31

Argh !!!

Je pensais avoir trouvé la solution, mais en fait cela n'a pas fonctionné...

Je l'indique, cela donnera peut etre des idées à quelqu'un et arrivera mieux que moi...

J'ai donc un peu farfouillé dans VS studio et ses fichiers, et j'ai supposer que VS se servait des fonctionnalités proposé à ses utilisateurs : Les macros...

Il y'a bien un exemple de macros qui contient notemment la procédure de génération de commentaires : Samples.Utilities.InsertDocComments() à partir de l'explorateur de macros, de plus on est autorisé à modifier les macros (Youpi ai-je pensé!!!).
J'ai donc pris mes petites mimines et zou j'suis parti à faire ce qui m'interressai :

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
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
...
editPoint.Insert(Microsoft.VisualBasic.Constants.vbTab & commentStart &
 "<summary>")
editPoint.Insert(Microsoft.VisualBasic.Constants.vbCrLf)
editPoint.Insert(Microsoft.VisualBasic.Constants.vbTab & commentStart & 
"Summary of " & codeElement.Name & ".")
editPoint.Insert(Microsoft.VisualBasic.Constants.vbCrLf)
editPoint.Insert(Microsoft.VisualBasic.Constants.vbTab & commentStart &
 "</summary>")
editPoint.Insert(Microsoft.VisualBasic.Constants.vbCrLf)
    '' LUDOVIC : DOCUMENTATION AUTOMATIQUE XML
    '' AJOUT DES COMMENTAIRES SPECIALISES
    '' <remarks>
    ''
    '' </remarks>
editPoint.Insert(Microsoft.VisualBasic.Constants.vbTab & commentStart &
 "<remarks>")
editPoint.Insert(Microsoft.VisualBasic.Constants.vbCrLf)
editPoint.Insert(Microsoft.VisualBasic.Constants.vbTab & commentStart &
 "")
editPoint.Insert(Microsoft.VisualBasic.Constants.vbCrLf)
editPoint.Insert(Microsoft.VisualBasic.Constants.vbTab & commentStart &
 "</remarks>")
editPoint.Insert(Microsoft.VisualBasic.Constants.vbCrLf)
'' <history>
''
'' </history>
editPoint.Insert(Microsoft.VisualBasic.Constants.vbTab & commentStart &
 "<history>")
editPoint.Insert(Microsoft.VisualBasic.Constants.vbCrLf)
editPoint.Insert(Microsoft.VisualBasic.Constants.vbTab & commentStart &
 vbTab & "[PRENOM]" & vbTab & Date.Today() & vbTab & "Created")
editPoint.Insert(Microsoft.VisualBasic.Constants.vbCrLf)
editPoint.Insert(Microsoft.VisualBasic.Constants.vbTab & commentStart &
 "</history>")
 
editPoint.Insert(Microsoft.VisualBasic.Constants.vbTab & commentStart)
...

J'ai enregistrer la macro, fermer VS, rebooter ... mais rien n'y fait...

Voila, une piste non fructueuse qui pourra peut etre en aider certain...

**sirex007** · 04/08/2006, 16h43

A priori c'est impossible, sans faire des modifications du code de visual studio, assez risqué donc!

Sinon, j'ai réussi à trouver un soft, pour ceux que ca interressera de faire cette manipulation via un outil externe à visual studio qui se nomme GhostDoc, on le trouvera facilement grace à notre google international

J'suis vache hein, eh ben non!!

J'vous met le liens du site : http://www.roland-weigelt.de/ghostdoc/

**olivier34** · 15/09/2009, 15h38

Quel dommage si cela n'est pas possible de réaliser cette customization sans passer par l'utilisation de logiciels tiers, qu'ils soient gratuits ou commerciaux.

Olivier.

**roster** · 15/09/2009, 19h37

C'est possible visiblement:
http://msdn.microsoft.com/fr-fr/libr...us,VS.71).aspx

**olivier34** · 16/09/2009, 08h46

Bonjour roster,

L'article que tu présentes explique les bases pour un utilisateur qui souhaite documenter son code, pas de la modification du mécanisme déclenché par la frappe des /// .

Mauvaise voie.

Olivier.