CKTIS / C
comments and documentation — notion C23
C accepte les commentaires de bloc `/* ... */` et de ligne `// ...` ; ils disparaissent lors d’une phase précoce de traduction et les blocs ne s’imbriquent pas. La documentation doit décrire contrats et raisons plutôt que répéter le code évident.
Version : C23
Syntaxe
comments and documentationC accepte les commentaires de bloc /* ... */ et de ligne // ... ; ils disparaissent lors d’une phase précoce de traduction et les blocs ne s’imbriquent pas. La documentation doit décrire contrats et raisons plutôt que répéter le code évident.
Un commentaire de fonction doit préciser propriété des pointeurs, unités de taille, signification du résultat et conditions d’échec. Dans un algorithme, il est utile s’il explique un invariant non évident ou la raison de l’ordre des opérations.
Un /* à l’intérieur d’un bloc n’ouvre pas de niveau ; le premier */ termine tout et peut exposer du code accidentel. Une macro ne peut pas commenter fiablement un texte arbitraire ; emploie un #if 0 contrôlé et garde un texte valide pour le préprocesseur.
Exemples
#include <stdio.h>
int main(void) {
/* A block comment cannot be nested. */
int value = 6; // The line comment ends at the newline.
printf("%d\n", value + 1);
return 0;
}
Résultat
7
C accepte les commentaires de bloc `/* ... */` et de ligne `// ...` ; ils disparaissent lors d’une phase précoce de traduction et les blocs ne s’imbriquent pas. La documentation doit décrire contrats et raisons plutôt que répéter le code évident.