CKTIS / C
comments and documentation — pojam C23
C podržava blokovske komentare `/* ... */` i retčane `// ...`; nestaju u ranoj fazi prevođenja, a blokovi se ne mogu ugnijezditi. Dokumentacija treba bilježiti ugovore i razloge ograničenja, ne ponavljati očit kod.
Verzija: C23
Sintaksa
comments and documentationC podržava blokovske komentare /* ... */ i retčane // ...; nestaju u ranoj fazi prevođenja, a blokovi se ne mogu ugnijezditi. Dokumentacija treba bilježiti ugovore i razloge ograničenja, ne ponavljati očit kod.
Komentar funkcije treba navesti vlasništvo pokazivača, jedinice veličine, značenje rezultata i uvjete pogreške. Unutar algoritma koristan je kada objašnjava neočit invariant ili razlog redoslijeda operacija.
Slijed /* unutar blokovskog komentara ne otvara novu razinu; prvi */ završava sve i može izložiti slučajan kod. Makro ne može pouzdano zakomentirati proizvoljan tekst; koristi kontrolirani #if 0 i zadrži tekst valjanim za pretprocesor.
Primjeri
#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 podržava blokovske komentare `/* ... */` i retčane `// ...`; nestaju u ranoj fazi prevođenja, a blokovi se ne mogu ugnijezditi. Dokumentacija treba bilježiti ugovore i razloge ograničenja, ne ponavljati očit kod.