Un commentaire en C est cité ainsi: /*
<ligne de commentaires> */ et il est possible de le faire tenir
sur plusieurs lignes. Tout ce qui se trouve entre les signes /*
et */ est ignoré par le compilateur.
Chaque fonction devrait comprendre un commentaire ainsi que tout code
non trivial. Il existe une bonne maxime qui dit que tout code mal
écrit requiert du commentaire. Ne commentez jamais ce qui est évident.
Expliquez pourquoi vous développez tel ou tel point mais pas
ce que vous faites. Il n'est pas judicieux de réaliser de jolis
graphiques entre les fonctions. Ainsi écrivez plutôt ceci:
/* returns -1 on eror, takes
a positive integer */
int sqr (int x) { < ... > |
/***************************--SQR--******************************
* x = argument to make the square of * * return value = * * -1 on error * * square of x (on success) * *********************************************************************
int sqr (int x)
|
int x;
x = 10; #if 0 printf ("debug: x is %d\n", x); /*print debug information */ #endif y = x + 10; < ... > |