CKTIS / C
comments and documentation — concept C23
C ondersteunt blokcommentaar `/* ... */` en regelcommentaar `// ...`; ze verdwijnen in een vroege vertaalfase en blokken kunnen niet worden genest. Documentatie hoort contracten en redenen vast te leggen, niet duidelijke code te herhalen.
Versie: C23
Syntax
comments and documentationC ondersteunt blokcommentaar /* ... */ en regelcommentaar // ...; ze verdwijnen in een vroege vertaalfase en blokken kunnen niet worden genest. Documentatie hoort contracten en redenen vast te leggen, niet duidelijke code te herhalen.
Een functiecommentaar hoort pointereigendom, grootte-eenheden, betekenis van het resultaat en foutvoorwaarden te noemen. In een algoritme is commentaar nuttig wanneer het een niet-vanzelfsprekende invariant of de reden voor de bewerkingsvolgorde uitlegt.
Een /* in blokcommentaar opent geen nieuw niveau; de eerste */ beëindigt alles en kan onbedoelde code blootleggen. Een macro kan willekeurige tekst niet betrouwbaar uitcommentariëren; gebruik gecontroleerd #if 0 en houd de tekst geldig voor de preprocessor.
Voorbeelden
#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;
}
Resultaat
7
C ondersteunt blokcommentaar `/* ... */` en regelcommentaar `// ...`; ze verdwijnen in een vroege vertaalfase en blokken kunnen niet worden genest. Documentatie hoort contracten en redenen vast te leggen, niet duidelijke code te herhalen.