CKTIS / C
comments and documentation — pojem C23
C podporuje blokové komentáre `/* ... */` a riadkové `// ...`; miznú v ranej fáze prekladu a bloky nemožno vnoriť. Dokumentácia má zachytiť zmluvy a dôvody obmedzení, nie opakovať zrejmý kód.
Verzia: C23
Syntax
comments and documentationC podporuje blokové komentáre /* ... */ a riadkové // ...; miznú v ranej fáze prekladu a bloky nemožno vnoriť. Dokumentácia má zachytiť zmluvy a dôvody obmedzení, nie opakovať zrejmý kód.
Komentár funkcie má uviesť vlastníctvo ukazovateľov, jednotky veľkostí, význam výsledku a podmienky chyby. Vnútri algoritmu je užitočný, ak vysvetľuje nezrejmý invariant alebo dôvod poradia operácií.
Sekvencia /* vnútri blokového komentára neotvorí ďalšiu úroveň; prvé */ všetko ukončí a môže odhaliť náhodný kód. Makro nedokáže spoľahlivo zakomentovať ľubovoľný text; použi riadené #if 0 a zachovaj text platný pre preprocesor.
Príklady
#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;
}
Výsledok
7
C podporuje blokové komentáre `/* ... */` a riadkové `// ...`; miznú v ranej fáze prekladu a bloky nemožno vnoriť. Dokumentácia má zachytiť zmluvy a dôvody obmedzení, nie opakovať zrejmý kód.