CKTIS / C
comments and documentation — pojem C23
C podpira bločne komentarje `/* ... */` in vrstične `// ...`; izginejo v zgodnji fazi prevajanja, blokov pa ni mogoče gnezditi. Dokumentacija naj beleži pogodbe in razloge omejitev, ne ponavlja očitne kode.
Različica: C23
Sintaksa
comments and documentationC podpira bločne komentarje /* ... */ in vrstične // ...; izginejo v zgodnji fazi prevajanja, blokov pa ni mogoče gnezditi. Dokumentacija naj beleži pogodbe in razloge omejitev, ne ponavlja očitne kode.
Komentar funkcije naj navede lastništvo kazalcev, enote velikosti, pomen rezultata in pogoje napake. V algoritmu je uporaben, ko pojasni neočiten invariant ali razlog za vrstni red operacij.
Zaporedje /* v bločnem komentarju ne odpre nove ravni; prvi */ konča vse in lahko razkrije nenamerno kodo. Makro ne more zanesljivo zakomentirati poljubnega besedila; uporabi nadzorovan #if 0 in ohrani besedilo veljavno za predprocesor.
Primeri
#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;
}
Rezultat
7
C podpira bločne komentarje `/* ... */` in vrstične `// ...`; izginejo v zgodnji fazi prevajanja, blokov pa ni mogoče gnezditi. Dokumentacija naj beleži pogodbe in razloge omejitev, ne ponavlja očitne kode.