CKTIS / C
comments and documentation — pojem C23
C podporuje blokové komentáře `/* ... */` a řádkové `// ...`; mizí v rané fázi překladu a bloky nelze vnořovat. Dokumentace má zachytit smlouvy a důvody omezení, ne opakovat zřejmý kód.
Verze: C23
Syntaxe
comments and documentationC podporuje blokové komentáře /* ... */ a řádkové // ...; mizí v rané fázi překladu a bloky nelze vnořovat. Dokumentace má zachytit smlouvy a důvody omezení, ne opakovat zřejmý kód.
Komentář funkce má uvést vlastnictví ukazatelů, jednotky velikostí, význam výsledku a podmínky chyby. Uvnitř algoritmu je užitečný, vysvětluje-li nezřejmý invariant nebo důvod pořadí operací.
Sekvence /* uvnitř blokového komentáře neotevře další úroveň; první */ vše ukončí a může odhalit náhodný kód. Makro nedokáže spolehlivě zakomentovat libovolný text; použij řízené #if 0 a zachovej text platný pro preprocesor.
Pří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ýsledek
7
C podporuje blokové komentáře `/* ... */` a řádkové `// ...`; mizí v rané fázi překladu a bloky nelze vnořovat. Dokumentace má zachytit smlouvy a důvody omezení, ne opakovat zřejmý kód.