Discussion :

[clampin]

Bonjour,

Question un peu idiote sans doute, mais quelle est la façon la plus claire pour présenter les commentaires ?

Vaut-il mieux présenter en haut du doucument l'ensemble des commentaires ? ou bien les placer dans le code ?

exemple

Code :

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

1
2
3
4
 
/* cette fonction calcule le taux d'imposition */
 
#include.....

ou bien près de la fonction

Code :

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

1
2
3
4
5
 
 
void mesImpots (void) // cette fonction calcule le teux d'imposition 
{
  ....

[salseropom]

Salut pour ma part, je fais comme suit :

Code :

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

1
2
3
4
5
6
7
8
9
10
 
int mafonction1(int)
{
/* cette fonction calcule ... */
}
 
int mafonction2(int)
{
/* cette fonction calcule ... */
}

[BainE]

Bonjour,

moi j aime bien comme ca :

Code :

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

1
2
3
4
5
6
7
8
9
 
/*********************************************************/
/* @NomFonction : foo                                    */
/* @auteur         : moi                                 */
/* @prototype     : void foo( int i )                    */
/* @argument     : int i : truc qui fait que ...         */
/* @algo et tout autre chose interessante, comme         */
/*                      a quoi sert  cette fonction ...  */
/*********************************************************/

C'est *impÔrtant* les commentaires

[muad'dib]

Si tu veux un code portable au maximum, il faut savoir que la norme C90 ne supporte que des commentaires de type /* */ non imbriqués (cf http://emmanuel-delahaye.developpez....m#commentaires)

[Emmanuel Delahaye]

Question un peu idiote sans doute, mais quelle est la façon la plus claire pour présenter les commentaires ?

Eléments de reflexion :

http://emmanuel-delahaye.developpez....m#commentaires