Комментарии обычно служат двум целям: документировать код и облегчить отладку. Так, если в программе используется некоторый специальный алгоритм, то будет уместен комментарий, содержащий ссылку на книгу или статью, в которой описывается этот алгоритм. То же касается разработанных программистом типов данных и функций, описание которых значительно облегчит понимание программы другим разработчиком.

Также комментарии полезны при отладке программы. Если программа работает не так, как надо, то иногда часть кода заключают в комментарии, заставляя компилятор игнорировать эту часть. Если после этого программа начнёт работать правильно, то закомментированный код содержит ошибку и должен быть исправлен. Если программа не заработает, отключаются новые фрагменты.

В C++ используются 2 вида комментариев: однострочный и многострочный. Для введения однострочного комментария используют пару символов //, после которых следует поясняющий текст до конца строки. Многострочные комментарии начинаются с символов /* и заканчиваются символами */.

Компилятор игнорирует комментарии в исходном тексте, таким образом, в объектный файл и конечную программу они не попадают.

Рекомендации по комментированию:

- начинать каждый модуль (или саму программу) с краткого описания этого модуля;

- комментировать основные этапы используемых алгоритмов;

- вкратце описывать созданные типы данных, функции;

- не вставлять комментарии в середину строки;

- не писать очевидных комментариев;

- начинать комментарий с той же позиции в строке (с таким же отступом), что и комментируемый текст.

<== предыдущая лекция	\|	следующая лекция ==>
Время существования и область видимости переменных	\|	Операции, выражения и операторы