Bonjour
je me demande quel est le format el plu sefficace pour decrire ce que fait une fonction
1) Premier format
ou bien
Code : Sélectionner tout - Visualiser dans une fenêtre à part
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 );
2) deuxieme format
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)
Code : Sélectionner tout - Visualiser dans une fenêtre à part
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*);
Quel vortre commentaire ?
Partager