Комментарии в C++: лучшие практики для читаемого и поддерживаемого кода

Комментарии в C++

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

В C++ комментарии — это аннотации, помогающие разработчикам читать и понимать код. Компилятор их полностью игнорирует, позволяя добавлять контекст, объяснять логику или временно отключать код.

Существует два стандартных способа добавления комментариев:

• // — однострочные комментарии
• /* */ — многострочные комментарии

---

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

Любая строка, начинающаяся с //, считается комментарием. Например:

// Объявить переменную
int a;
// Инициализировать переменную 'a' значением 2
a = 2;

В фрагменте выше первые две строки — однострочные комментарии, объясняющие каждый шаг. Можно также разместить комментарий в конце строки кода:

int a; // Объявить переменную

---

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

Все, что находится между /* и */, является комментарием, охватывающим одну или несколько строк. Пример:

/*
 * Объявить переменную
 * для хранения зарплаты сотрудников
 */
int salary = 2000;

Этот синтаксис достаточно гибок для документирования как кратких, так и обширных участков кода.

---

Использование комментариев для отладки

Комментарии могут временно подавлять код, что полезно при локализации ошибок. Рассмотрим программу:

#include <iostream>
using namespace std;
int main() {
    cout << "some code";
    cout << ''error code;
    cout << "some other code";
    return 0;
}

Если программа не компилируется, можно закомментировать проблемную строку вместо удаления:

#include <iostream>
using namespace std;
int main() {
    cout << "some code";
    // cout << ''error code;
    cout << "some other code";
    return 0;
}

Профессиональный совет: Большинство IDE позволяют быстро переключать комментарии — используйте Ctrl + / в Windows или Cmd + / в macOS.

---

Зачем нужны комментарии?

Комментарии служат живой документацией, сохраняющей понятность кода для вас и вашей команды со временем. Они должны прояснять «почему» за решением, а не просто повторять, что делает код.

Примечание: Не полагайтесь на комментарии, чтобы объяснять плохо написанный код. Стремитесь к ясной, самодокументируемой логике и используйте комментарии для контекста, где это необходимо.

Как общее правило, используйте комментарии для объяснения обоснования решения, а не механики реализации.