Комментарии

Материал из Энциклопедия о программировании
Перейти к: навигация, поиск

Комментарии — пояснительные записи, написанные на обычном разговорном языке, оставляемые программистами в написанном ими коде.

Виды

Комментарии бывают однострочные и многострочные. В некоторых языках многострочные комментарии могут быть обычными и документирующими.

Синтаксис

Разные виды комментариев отличаются синтаксисом. В разных языках программирования различный синтаксис тех и др. комментариев. Бывает, что какого-то вида комментариев нет и вовсе.

Перед однострочным комментарием идёт специальный предшествующий/начальный идентификатор, после чего до конца строки идёт сам текст комментария. В качестве такого предшествующего идентификатора могут служить следующие символы и наборы: //, #, --.

Многострочные комментарии обрамляются с двух сторон, в начале и в конце, специальными идентификаторами. Это могут быть: /* ... */, /** ... */, <!-- ... -->.

Философия

Согласно сложившийся философии программирования, в языках программирования высокого уровня должно быть минимум комментариев. Хороший код комментировать не нужно. Разве что какие-то сложные моменты, почему сделано именно так, а не иначе, как наиболее очевидно. Или если сложный алгоритм, то его пояснение. Комментировать функцию, например, add() не имеет смысла, и комментарии будут только мешать.