format de commentaires pour les entetes de fonctions
Bonjour
je me demande quel est le format el plu sefficace pour decrire ce que fait une fonction
1) Premier format
Code:
1 2 3 4 5 6 7 8 9
| // teste si la liset est vide
int
// 1 : liste est vide
// 0 : liste non vide
LST_isEmpty(
const LST_t*
// IN
// liste verifier el contenu
); |
ou bien
2) deuxieme format
Code:
1 2 3 4 5 6 7 8 9 10
|
// teste si la liset est vide
//
// Parametres
// const LST_t* : IN : liset a tester
//
// return
// 1 : liste est vide
// 0 : liste non vide
int LST_isEmpty( const LST_t*); |
Remarque le deuxieme format presente une redondance pour la liset des parametres ( il peut arriver d'ajouter un parametre ou suprimer sans mettre a jour le commentaire)
Quel vortre commentaire ?
Re: format de commentaires pour les entetes de fonctions
Citation:
Envoyé par Mokhtar BEN MESSAOUD
Bonjour
je me demande quel est le format el plu sefficace pour decrire ce que fait une fonction
1) Premier format
Code:
1 2 3 4 5 6 7 8 9
| // teste si la liset est vide
int
// 1 : liste est vide
// 0 : liste non vide
LST_isEmpty(
const LST_t*
// IN
// liste verifier el contenu
); |
ou bien
2) deuxieme format
Code:
1 2 3 4 5 6 7 8 9 10
|
// teste si la liset est vide
//
// Parametres
// const LST_t* : IN : liset a tester
//
// return
// 1 : liste est vide
// 0 : liste non vide
int LST_isEmpty( const LST_t*); |
Remarque le deuxieme format presente une redondance pour la liset des parametres ( il peut arriver d'ajouter un parametre ou suprimer sans mettre a jour le commentaire)
Quel vortre commentaire ?
Moi, je fais comme ça :
A l'arrache :
Code:
1 2 3 4
|
/* ---------------------------------------------------------------------
<comments>
--------------------------------------------------------------------- */ |
En production :
Code:
1 2 3 4 5 6 7 8 9 10
|
/* ---------------------------------------------------------------------
<function name> ()
---------------------------------------------------------------------
<description>
---------------------------------------------------------------------
I: <input parameters>
I: <input parameters>
O: <output values>
--------------------------------------------------------------------- */ |