Un logiciel pour commenter mon code

Résolu
Signaler
Messages postés
805
Date d'inscription
jeudi 22 mai 2003
Statut
Membre
Dernière intervention
30 octobre 2010
-
Messages postés
6351
Date d'inscription
samedi 1 juin 2002
Statut
Modérateur
Dernière intervention
2 août 2014
-
Salut
j'ai presque fini mon projet, alors qu'il est trè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éthode....), avez-vous un à me conseiller??

Merci
YaoYao !!
1 + 1 = 10

9 réponses

Messages postés
52
Date d'inscription
jeudi 28 octobre 2004
Statut
Membre
Dernière intervention
24 août 2005
1
je parlais bien du code fait par toi-meme. Crée un diagramme de classe,
fait un drag & drop de tes fichiers dedans: les classses vont
apparaitre,et dans les propriété du verra les champs remarks et summery
pour y mettre tes commentaires

Miiitch
Messages postés
6351
Date d'inscription
samedi 1 juin 2002
Statut
Modérateur
Dernière intervention
2 août 2014
98
Salut,

Sinon, directement dans le code, tu te met sur une ligne vierge au dessus de ta classe/struc/methode/propriété/champs/... et tu met ///
Pour une méthode VS te mettra automatiquement le tag pour chaque param par exemple.

Cocoricoooooooo !!!!
coq
MVP Visual C#
Messages postés
52
Date d'inscription
jeudi 28 octobre 2004
Statut
Membre
Dernière intervention
24 août 2005
1
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étés du designer. Pour l'avoir
fait, c'est tres pratique.

Miiitch
Messages postés
805
Date d'inscription
jeudi 22 mai 2003
Statut
Membre
Dernière intervention
30 octobre 2010

oui, mais moi je parle a propos du code fé par moi, pas celui auto-crée par visual studio 2005 qui est auto-commenté.

Merci
YaoYao !!
1 + 1 = 10
Messages postés
805
Date d'inscription
jeudi 22 mai 2003
Statut
Membre
Dernière intervention
30 octobre 2010

je v voir ca

YaoYao !!
1 + 1 = 10
Messages postés
805
Date d'inscription
jeudi 22 mai 2003
Statut
Membre
Dernière intervention
30 octobre 2010

j'ai fé du texte dans summary et remarks et returns, mais je vois que seul summary qui quand je veux declarer ma méthode, quel est l'interet des autres alors?

Merci
YaoYao !!
1 + 1 = 10
Messages postés
6351
Date d'inscription
samedi 1 juin 2002
Statut
Modérateur
Dernière intervention
2 août 2014
98
returns est a mettre pour documenter le retour d'une methode
Si elle est en void il ne sert donc à rien.
remarks sert à mettre des notes (bref ça reprend l'architecture de la doc du framework.)

Cocoricoooooooo !!!!
coq
MVP Visual C#
Messages postés
3246
Date d'inscription
lundi 25 avril 2005
Statut
Modérateur
Dernière intervention
27 octobre 2012
41
Je ne connais pas les capacités de VS2005 pour la documentation mais avant j'utilisais NDoc, tu passes ton code marqué avec les balises XML ( summary, ect.. ) à 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 )
Messages postés
6351
Date d'inscription
samedi 1 juin 2002
Statut
Modérateur
Dernière intervention
2 août 2014
98
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#