Урок №9. Комментарии | Уроки С++

  Обновл. 25 Апр 2019  | 

Комментарий – это строка (или несколько строк) текста, которая вставляется в исходный код для объяснения того, что делает этот код. В C++ есть два типа комментариев: однострочные и многострочные.

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

Однострочные комментарии – это комментарии, которые пишутся после символов //. Они размещаются в отдельных строках и всё, что находится после этих символов комментирования – игнорируется компилятором. Например:

std::cout << «Hello, world!» << std::endl; // всё, что находится от начала двойного слеша — игнорируется компилятором



std::cout << «Hello, world!» << std::endl; // всё, что находится от начала двойного слеша — игнорируется компилятором

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

std::cout << «Hello, world!» << std::endl; // cout и endl находятся в библиотеке iostream
std::cout << «It is so exciting!» << std::endl; // эти комментарии усложняют чтение кода
std::cout << «Yeah!» << std::endl; // особенно, когда строки разной длины



std::cout << «Hello, world!» << std::endl; // cout и endl находятся в библиотеке iostream

std::cout << «It is so exciting!» << std::endl; // эти комментарии усложняют чтение кода

std::cout << «Yeah!» << std::endl; // особенно, когда строки разной длины

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

// cout и endl находятся в библиотеке iostream
std::cout << «Hello, world!» << std::endl;

// теперь уже легче читать
std::cout << «It is so exciting!» << std::endl;

// не так ли?
std::cout << «Yeah!» << std::endl;



// cout и endl находятся в библиотеке iostream

std::cout << «Hello, world!» << std::endl;

 

// теперь уже легче читать

std::cout << «It is so exciting!» << std::endl;

 

// не так ли?

std::cout << «Yeah!» << std::endl;

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

Многострочные комментарии – это комментарии, которые пишутся между символами /* */. Всё, что находится между звёздочками – игнорируется компилятором:

/* Это многострочный комментарий.
Эта строка игнорируется
и эта тоже. */



/* Это многострочный комментарий.

Эта строка игнорируется

и эта тоже. */

Так как всё, что находится между звёздочками – игнорируется, то иногда вы можете наблюдать следующее:

/* Это многострочный комментарий.
* Звёздочки слева
* упрощают чтение текста
*/



/* Это многострочный комментарий.

* Звёздочки слева

* упрощают чтение текста

*/

Многострочные комментарии не могут быть вложенными (т.е. одни комментарии внутри других):

/* Это многострочный /* комментарий */ а это уже не комментарий */
// Верхний комментарий заканчивается перед первым */, а не перед вторым */



/* Это многострочный /* комментарий */ а это уже не комментарий */

// Верхний комментарий заканчивается перед первым */, а не перед вторым */

Правило: Никогда не используйте вложенные комментарии.

Как правильно писать комментарии?

Во-первых, на уровне библиотек/программ/функций комментарии отвечают на вопрос «ЧТО?»: «Что делают эти библиотеки/программы/функции?». Например:

// Эта программа вычисляет оценку студента за семестр на основе его оценок за модули

// Эта функция использует метод Ньютона для вычисления корня функции

// Следующий код генерирует случайное число



// Эта программа вычисляет оценку студента за семестр на основе его оценок за модули

 

// Эта функция использует метод Ньютона для вычисления корня функции

// Следующий код генерирует случайное число

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

Во-вторых, внутри библиотек/программ/функций комментарии отвечают на вопрос «КАК?»: «Как код выполняет задание?»:

/* Для расчёта итоговой оценки студента, мы добавляем все его оценки за уроки и домашние задания,
а затем делим получившееся число на общее количество оценок.
Таким образом мы получаем средний балл студента. */



/* Для расчёта итоговой оценки студента, мы добавляем все его оценки за уроки и домашние задания,

   а затем делим получившееся число на общее количество оценок.

   Таким образом мы получаем средний балл студента. */

// Чтобы получить рандомный (случайный) элемент, мы выполняем следующее:

// 1) Составляем список всех элементов.
// 2) Вычисляем среднее значение для каждого элемента, исходя из его веса, цвета и цены.
// 3) Выбираем любое число.
// 4) Определяем соответствие элемента случайно выбранному числу.
// 5) Возвращаем случайный элемент.



// Чтобы получить рандомный (случайный) элемент, мы выполняем следующее:

 

// 1) Составляем список всех элементов.

// 2) Вычисляем среднее значение для каждого элемента, исходя из его веса, цвета и цены.

// 3) Выбираем любое число.

// 4) Определяем соответствие элемента случайно выбранному числу.

// 5) Возвращаем случайный элемент.

Эти комментарии позволяют пользователю понять, каким образом код выполняет поставленное ему задание.

В-третьих, на уровне стейтментов (однострочного кода) комментарии отвечают на вопрос «ПОЧЕМУ?»: «Почему код выполняет задание именно таким образом, а не другим?». Плохой комментарий на уровне стейтментов объясняет, что делает код. Если вы когда-нибудь писали код, который был настолько сложным, что нужен был комментарий, который бы объяснял, что он делает, то вам нужно было бы не писать комментарий, а переписывать целый код.

Примеры плохих и хороших однострочных комментариев: