CKTIS / C
comments and documentation — понятие C23
C поддържа блокови коментари `/* ... */` и редови `// ...`; те изчезват в ранна фаза на транслацията и блоковете не могат да се влагат. Документацията трябва да записва договори и причини, а не да повтаря очевиден код.
Версия: C23
Синтаксис
comments and documentationC поддържа блокови коментари /* ... */ и редови // ...; те изчезват в ранна фаза на транслацията и блоковете не могат да се влагат. Документацията трябва да записва договори и причини, а не да повтаря очевиден код.
Коментарът на функция трябва да задава собствеността на указателите, единиците за размер, значението на резултата и условията за грешка. В алгоритъм е полезен, когато обяснява неочевиден инвариант или причината за реда на операциите.
Последователност /* в блоков коментар не отваря ново ниво; първото */ приключва всичко и може да разкрие случаен код. Макрос не може надеждно да коментира произволен текст; използвай контролиран #if 0 и пази текста валиден за препроцесора.
Примери
#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;
}
Резултат
7
C поддържа блокови коментари `/* ... */` и редови `// ...`; те изчезват в ранна фаза на транслацията и блоковете не могат да се влагат. Документацията трябва да записва договори и причини, а не да повтаря очевиден код.