Discussion :

[basnifo]

Bonjour

J'ai un projet que j'aimerais bien commenter de facon un peu plus "claire".
J'ai bien des commentaires mais bon ...

Mes questions sont donc :
- Comment bien commenter son code facilement sans que ca soit illisible ?
- Existe t'il des mani�res de commenter / des outils (internes ?) pour Visual C++ 6 ? (et non .net) (un peu comme la java doc par exemple ...)

merci !


La FAQ et la recherche ne m'ont pas aid� ...

[Aurelien.Regat-Barrel]

Avec VC++ 2005 y'a les commentaires xml, � la C#. Mais on utilise plus traditionnellement doxygen.
Les commentaires doivent apporter quelque chose. Si c'est pour r��crire en fran�ais le code C++, �a sert � rien. Par contre si tu expliques ton algo et le r�le des variables, c'est utile. Perso, j'essaye de d�crire mon algo, pour que si on supprime le code on puisse retrouver son fonctionnement via les commentaires. Mais j'aime bien aussi l'approche de la programmation XP qui dit aucun commentaire car s'il en faut c'est que le code est dur � comprendre, donc il faut le retravailler pour le simplifier. C'est exag�r�, mais tu vois l'id�e : commenter ce que fait le code, et non comment il le fait.
Ecrire les commentaires avant le code, c'est utile aussi pour se rendre compte de b�tises avant de les �crire.

[barthelv]

Comme outil il existe Doxygen qui est gratuit, tres simple et fait des docs super. Il te cree meme les schemas qui te montrent comment s'incluent tes fichiers et classes. Tres utile pour voir si l'on a fait du code propre. Il est tres utilise dans le monde professionnel.

http://www.stack.nl/~dimitri/doxygen/

Pleins d'exemples de docs avec Doxygen:

http://www.stack.nl/~dimitri/doxygen/projects.html

[basnifo]

doxygen .. je vais me renseigner ..

Sinon j'ai bien pr�cis� VC++ 6, pas 2005 ...

En fait je programme depuis quelques ann�es donc je sais commenter "en gros".

Mais la je chercherais � avoir quelque chose de plus propre, p-e m�me que VC++ 6 utilise des instructions pour les commentaires afin de pouvoir les traiter ... bref cela je ne le sais pas , d'o� ma question

merci ...

EDIT : merci aussi barthelv Je vais donc voir d'un peu plus pr�s ce logiciel ...
Si vous avez d'autres renseignements � m'apporter, n'hesitez pas