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

Доброго времени суток! Сейчас пойдет речь о часто встречаемой конструкции в C++ - комментариях. Комментарии к коду вы встретите в каждом серьезном проекте, поскольку без них было бы очень тяжело разобраться в чужом коде (да что уж там, даже в своем спустя пару месяцев :-) ).

Видео урок

Что такое комментарии?

Комментарии - это текст, который будет виден только при редактировании кода. При компиляции программы комментарии игнорируется компилятором. Именно поэтому в комментариях можно писать абсолютно любой текст, который придут нам в голову.

Типы комментариев в C++

В C++ существуют всего два типа комментариев:

• однострочные комментарии;
• многострочные комментарии;

Собственно об этих типах и пойдет речь в нашем уроке.

Однострочные комментарии

Этот тип комментариев используется для комментирование в рамках одной строки.

Вот пример использования однострочного комментария:

int main() { // функция main

Структура данного комментария выглядит следующим образом: сначала мы начинаем комментарий с двух слешей // после которых следует любой текст до конца строки.

В данном примере мы добавили пояснение к стандартной функции main. В своих же программах вы можете использовать более развернутое описание для каждой из функций (ведь не всегда можно понять назначение функции лишь по ее названию).

А мы переходим к многострочным комментариям.

Многострочные комментарии

Данные комментарии нужны для комментирования больших (или не очень) участков текста. Главное отличие многострочных комментариев - это возможность закомментировать сразу несколько строк.

Вот пример кода:

#include <iostream>
using namespace std;

int main() {
    /*
        Функция main.
        Автоматически вызывается
        вместе с программой
    */

    return 0;
}

Теперь разберем структуру многострочных комментариев:

1. Многострочный комментарий начинается с /*.
2. После идет любой текст, который и будет комментарием.
3. Заканчивается комментарий на символах */.

Вот и все. Теперь, когда мы разобрались с реализацией комментариев в C++, можем переходить к практическому применению их в своих программах.

Для чего используются комментарии

Я смог выделить два практических примера комментирования, которые вы сможете использовать в реальных программах. Собственно давайте их и подробно разберем.

Пояснения

Очень часто комментарии используют для пояснения отдельных участков кода или программы в целом. Для этого могут использоваться однострочные (для пояснения отдельной строки кода) или многострочные (чтобы указать различные назначение функций или целых программ).

Давайте рассмотрим пример комментирования:

/*
  программа lesson_2.cpp
  выводит на экран сообщение:
  Hello!
  I am new program.
*/
#include <iostream>
using namespace std;

int main() // функция main
{
    cout << "Hello!" << endl; // первая строка сообщения
    cout << "I am new program." << endl; // вторая часть

    return 0; // возвращаем код 0
}

Думаю здесь все понятно. Идем дальше.

Устранение ошибок

Это отдельная тема для обсуждения. Процесс устранения ошибок также называют отладкой (о ней мы поговорим позже). Мы разберем лишь один способ, для которого и нужны комментарии.

Так как же мы будем устранять ошибки при помощью комментирования? Очень просто. Мы удаляем кусок кода с помощью комментариев и пытаемся запустить программу. Если она запустилась, то нам надо искать ошибку в удаленной части кода:

#include <iostream>
using namespace std;

int main() {
    // cout << "My test program: << endl;
    cout << 5 << endl;

    return 0;
}

Как видите в строке № 5 была ошибка: мы забыли закрыть кавычку после program:. После удаление этой строки наша программа исправно работает, а это значит мы без труда сможем найти ошибку в одной строке кода!

Заключение

Вот что можно выделить из данного урока:

• Комментарии игнорируется компилятором.
• В C++ есть два типа комментариев:
  • однострочные;
  • многострочные;
• С помощью комментариев можно пояснять код или устранять ошибки.

На этом мы заканчиваем.

Основы C++ »

« Переменные в C++