Discussion :

[canard75]

Bonjour,

Je me demandais si il n'y a pas une norme quant à la forme des commentaires. Par exemple ceux précédant une fonction.

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
/* 
 * Function foo
 * return value: void
 * parameters: void
 */
void foo(void);

Merci d'avance

[Médinoc]

Ben, il y a les formats de commentaires Doxygen, mais je ne sais plus si c'est parsonnalisabel ou non...
Et quand on programme en java, il y a les commentaires javadoc...

[Franck.H]

Il n'y a pas de normes pour la mise en forme des commentaires !

[Médinoc]

De Norme, non, mais il y a des formats étudiés pour des parseurs, c'est ce que je voulais dire...

[Emmanuel Delahaye]

Je me demandais si il n'y a pas une norme quant à la forme des commentaires. Par exemple ceux précédant une fonction.

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
/* 
 * Function foo
 * return value: void
 * parameters: void
 */
void foo(void);

Il n'y a pas de norme. Juste des regles de bon sens qui peuvent être plus ou moins formalisées par les société ou organismes pour lesquels tu travailles.

Voici les miennes :

http://emmanuel-delahaye.developpez.com/codage.htm

[Sib]

L'intérêt de "formater" ses commentaires au format Doxygen (par exemple), c'est que Doxygen permet, par la suite, de générer automatiquement la documentation relative au code..
Intéressant sur de gros codes, et si l'on a besoin de le documenter ..

[canard75]

bon à savoir !