un logiciel pour commenter mon codeRésolu

Question

Salut
j'ai presque fini mon projet, alors qu'il est tr&#232;s grand (40 000 lignes),je dois le commenter pour que je peux le reprendre pour faire des mise a jour..., je cherche pour cela un logiciel qui m'aide a le bien commenter ( class,m&#233;thode....), avez-vous un &#224; me conseiller??

Merci
YaoYao !!
1 + 1 = 10

Miiitch · Accepted Answer

je parlais bien du code fait par toi-meme. Cr&#233;e un diagramme de classe,
fait un drag & drop de tes fichiers dedans: les classses vont
apparaitre,et dans les propri&#233;t&#233; du verra les champs remarks et summery
pour y mettre tes commentaires

Miiitch

Miiitch · Answer

Si tu peux utiliser visual studio 2005, utilise le class designer: ca
te permettra d'homogeneiser les noms de tes classes,methodes et de
directement y mettre des commentaire sans ecrire une seule ligne de
code, mais plutot remplir des propri&#233;t&#233;s du designer. Pour l'avoir
fait, c'est tres pratique.

Miiitch

Fildomen · Answer

oui, mais moi je parle a propos du code f&#233; par moi, pas celui auto-cr&#233;e par visual studio 2005 qui est auto-comment&#233;.

Merci
YaoYao !!
1 + 1 = 10

cs_coq · Answer

Salut, 

Sinon, directement dans le code, tu te met sur une ligne vierge au dessus de ta classe/struc/methode/propri&#233;t&#233;/champs/... et tu met ///
Pour une m&#233;thode VS te mettra automatiquement le tag pour chaque param par exemple.

Cocoricoooooooo !!!!
coq
MVP Visual C#

Fildomen · Answer

je v voir ca

YaoYao !!
1 + 1 = 10

Fildomen · Answer

j'ai f&#233; du texte dans summary et remarks et returns, mais je vois que seul summary qui quand je veux declarer ma m&#233;thode, quel est l'interet des autres alors?

Merci
YaoYao !!
1 + 1 = 10

cs_coq · Answer

returns est a mettre pour documenter le retour d'une methode
Si elle est en void il ne sert donc &#224; rien.
remarks sert &#224; mettre des notes (bref &#231;a reprend l'architecture de la doc du framework.)

Cocoricoooooooo !!!!
coq
MVP Visual C#

Lutinore · Answer

Je ne connais pas les capacit&#233;s de VS2005 pour la documentation mais avant j'utilisais NDoc, tu passes ton code marqu&#233; avec les balises XML ( summary, ect.. ) &#224; NDoc et il te sort un fichier HTML ou CHM ou meme en Hx je sais pas quoi... (  le nouveau format d'aide de Microsoft )

cs_coq · Answer

Pour l'utilisation de NDoc avec .Net 2.0 => http://ndoc.sourceforge.net/wiki/dotNet_2.0_Support
L'interet des commentaires xml dans le code est aussi d'avoir l'aide durant la saisie. :-)

Cocoricoooooooo !!!!
coq
MVP Visual C#

Un logiciel pour commenter mon code

9 réponses

Votre réponse

Discussions similaires