Discussion :

[mambo]

Bonjour tlm,

Est ce que quelqu'un saurait s'il existe des méthodologies de commentaires du code?

Merci.

[superspag]

perso, j'utilise d'oxygen...
1/ les codes sont clairement commentés
2/ les doc générées sont claires et bien illustrées

Bon ok, faut dire aussi que je n'ai jamais rien essayé d'autre

[mambo]

Tu pourrais me dire un peu plus sur d'oxygen?

[superspag]

ils en parlent un peu là : http://fr.wikipedia.org/wiki/Doxygen

Le site officiel : http://www.doxygen.org/

Il y a pas mal d'exemples sur ces sites.
En gros, en respectant les formes de Doxygen, non seulement tu commentes ton code de manière claire et complete, mais en prime, tu peux utiliser le programme Doxygen qui va analyser tes sources et te générer une documentation au format que tu veux... HTML par exemple

[Invité]

Tu pourrais me dire un peu plus sur d'oxygen?

doxygen, c'est un outil qui scrute les commentaires dans ton code et génere une doc qu format que tu lui demande (HTML, man, etc...) un peu a la maniere de la javadoc. tu devrais aller voir sur le site officiel... par ailleurs, le fichier d'aide en local (.hlp) quand tu installe doxywizard est tres complete quant à la syntaxe a respecter...

[mambo]

Merci bcp à tous les deux je vais m'y mettre.

[Eusebe]

Tu trouveras un tuto là :
http://cyberzoide.developpez.com/java/doxygen/

D'accord, c'est pour java, mais pour commenter, ça change pas beaucoup

[mambo]

Est ce qu'il y a d'autres façons de faire?

J'ai besoin de 2 ou 3 méthodologies pour faire une comparaison.

Merci d'avance.