Комментарии в C++: разбираем с примерами

Доброго времени суток! Сейчас пойдет речь о часто встречаемой конструкции в C++ - комментариях. Комментарии к коду вы встретите в каждом серьезном проекте, поскольку без них было бы очень тяжело разобраться в чужом коде (да что уж там, даже в своем спустя пару месяцев :-) ).
Видео урок
Что такое комментарии?
Комментарии - это текст, который будет виден только при редактировании кода. При компиляции программы комментарии игнорируется компилятором. Именно поэтому в комментариях можно писать абсолютно любой текст, который придут нам в голову.
Типы комментариев в C++
В C++ существуют всего два типа комментариев:
- однострочные комментарии;
- многострочные комментарии;
Собственно об этих типах и пойдет речь в нашем уроке.
Однострочные комментарии
Этот тип комментариев используется для комментирование в рамках одной строки.
Вот пример использования однострочного комментария:
int main() { // функция main
Структура данного комментария выглядит следующим образом: сначала мы начинаем комментарий с двух слешей //
после которых следует любой текст до конца строки.
В данном примере мы добавили пояснение к стандартной функции main
. В своих же программах вы можете использовать более развернутое описание для каждой из функций (ведь не всегда можно понять назначение функции лишь по ее названию).
А мы переходим к мно гострочным комментариям.
Многострочные комментарии
Данные комментарии нужны для комментирования больших (или не очень) участков текста. Главное отличие многострочных комментариев - это возможность закомментировать сразу несколько строк.
Вот пример кода:
#include <iostream>
using namespace std;
int main() {
/*
Функция main.
Автоматически вызывается
вместе с программой
*/
return 0;
}
Теперь разберем структуру многострочных комментариев:
- Многострочный комментарий начинается с
/*
. - После идет любой текст, который и будет комментарием.
- Заканчивается комментарий на символах
*/
.
Вот и все. Теперь, когда мы разобрались с реализацией комментариев в C++, можем переходить к практическому применению их в своих программах.
Для чего используются комментарии
Я смог выделить два практических примера комментирования, которые вы сможете использовать в реальных программах. Собственно давайте их и подробно разберем.