Commentaires en VB.NET pour la documentation

Signaler
Messages postés
72
Date d'inscription
mardi 16 avril 2002
Statut
Membre
Dernière intervention
12 février 2008
-
 Utilisateur anonyme -
Bonjour,

Je souhaite intégrer dans ma documentation générée les commentaires écrits dans le code code.
Habituellement j'utilise le caractère " ' " ou REM. Dans ce cas les commentaires ne sont gardés dans la génération de la doc.

Si quelqu'un a une idée....

Merci d'avance.

MELISA

3 réponses


Bonsoir chez-nous, Bonjour chez-nous,

VB10 de Microsoft reconnaît l'apostrophe comme une marque de commentaire. Comme ils sont plutôt conservateurs, j'imagine que Rem devrait fonctionner aussi dans le programme.

Pour ce que devine de la question, il semble que la reconnaissance des commentaires, vienne d'un programme annexe qui sert à préparer la documentation. Si j'ai bien deviné il y a quand même une autre fonctionnalité de VB.net qui mérite d'être mieux connue. Mettre trois apostrophes consécutives, sur la même ligne. Miracle, vous avez une zone de commentaires verte qui s'ouvre. Tout ce que vous écrivez dans cette zone (en respectant les trois apostrophes au début de chaque ligne et les balises XML) est conservé dans le listage du programme et dans un fichier XML du même nom que le projet. Il se retrouve dans le dossier Bin\debug du projet. Pour peu que l'on pense à le faire pour chaque procédure, une bonne partie de la documentation se fait au fur et à mesure du codage.
1
Merci

Quelques mots de remerciements seront grandement appréciés. Ajouter un commentaire

Codes Sources 195 internautes nous ont dit merci ce mois-ci

Messages postés
20
Date d'inscription
vendredi 25 juillet 2003
Statut
Membre
Dernière intervention
2 mai 2005

J'ai le meme problème ... J'ai beau essayer les mots clés dispo dans la doc, ça ne fonctionne pas... Mais est-ce 'Purpose, ' Purpose ? Faut il placer ces commentaires avant ou après la déclaration de la fonction ou procédure ?

Titre de section |
Description du commentaire |
----

Purpose (but),
Décrit ce que fait la procédure (et non comment elle le fait),
----

Assumptions (Données de base),
Répertorie chaque variable externe, contrôle, fichier ouvert ou autre élément auquel la procédure accède.,
----

Effects (Effets),
Répertorie chaque variable externe, contrôle ou fichier affecté, ainsi que ses effets (uniquement si ce n'est pas évident),
----

Inputs (Entrées),
Spécifie l'objectif attaché à l'argument,
----

Returns (Résultats),
Explique les valeurs retournées par les fonctions.

Merci

Fred

Bonjour,

Le vieux a oublié une chose au sujet de ses trois apostrophes. Il faut les mettre juste avant la ligne Sub (Function) Machin-chouette()