Комментарии - это заметки для программистов, которые компилятор игнорирует. Они используются для объяснения кода, разделения кода на логические блоки или временного отключения части кода.
Однострочные комментарии
Однострочные комментарии начинаются с двух прямых слешей (//) и продолжаются до конца строки.
// Это однострочный комментарий
int x = 5; // Это тоже однострочный комментарий
Многострочные комментарии
Многострочные комментарии начинаются с символов /* и заканчиваются символами */. Они могут охватывать несколько строк.
/* Это
многострочный
комментарий */
/* Это тоже
допустимый многострочный комментарий */
Примечание: Многострочные комментарии нельзя вкладывать друг в друга. Следующий код вызовет ошибку компиляции:
/* Это внешний комментарий
/* Это внутренний комментарий */
Это все еще часть внешнего комментария? */
Использование комментариев
Комментарии следует использовать для:
- Объяснения сложных алгоритмов или логики
- Документирования функций и классов
- Временного отключения части кода при отладке
- Добавления заметок для будущей доработки
Пример использования комментариев:
#include <iostream>
// Функция для вычисления факториала числа
int factorial(int n) {
if (n <= 1) return 1; // базовый случай
return n * factorial(n - 1); // рекурсивный вызов
}
int main() {
int num = 5;
std::cout << "Факториал " << num << " равен " << factorial(num) << std::endl;
/* TODO: Добавить проверку на отрицательные числа
и обработку ошибок */
return 0;
}
Помните, что излишнее комментирование может сделать код менее читаемым. Старайтесь писать самодокументируемый код, используя понятные имена переменных и функций, и добавляйте комментарии только там, где это действительно необходимо.