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

  Юрий  | 

    | 

  Обновл. 23 Фев 2019  | 

 33758

 ǀ   7 

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

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

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

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

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

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


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

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

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

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

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

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

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

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

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

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

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

   Плохой комментарий:

(По коду это и так понятно)

   Хороший комментарий:

(Теперь мы знаем, ПОЧЕМУ зрение у игрока равно нулю)

   Плохой комментарий:

(Да, мы видим, что здесь подсчёт стоимости, но почему элементы делятся на 2?)

   Хороший комментарий:

(Теперь понятно!)

Программистам часто приходится принимать трудные решения по поводу того, каким способом решить проблему. А комментарии и существуют для того, чтобы напомнить себе (или объяснить другим) причину, почему вы написали код именно так, а не иначе.

   Хорошие комментарии:

И, наконец, комментарии нужно писать так, чтобы человек, который не имеет ни малейшего представления о том, что делает ваш код – смог в нём разобраться. Очень часто случаются ситуации, когда программист говорит: «Это же совершенно очевидно, что делает код! Я это точно не забуду». Угадайте, что случится через несколько недель или даже дней? Это не совершенно очевидно, и вы удивитесь, как скоро вы забудете, что делает ваш код. Вы (или кто-то другой) будете очень благодарны себе за то, что оставите комментарии, объясняя на человеческом языке что, как и почему делает ваш код. Читать отдельные строки кода – легко, понимать их логику и смысл – сложно.

Подытожим:

   На уровне библиотек/программ/функций оставляйте комментарии, отвечая на вопрос «ЧТО?».

   Внутри библиотек/программ/функций оставляйте комментарии, отвечая на вопрос «КАК?».

   На уровне стейтментов оставляйте комментарии, отвечая на вопрос «ПОЧЕМУ?».

Закомментирование


Закомментировать код – это конвертировать одну или нескольких строк кода в комментарии. Таким образом, вы сможете (временно) исключить части кода от компиляции.

Чтобы закомментировать одну строчку кода, используйте однострочные символы комментирования //.

Не закомментировано:

Закомментировано:

Чтобы закомментировать блок кода, используйте однострочные символы комментирования // на каждой строке или символы многострочного комментария /* */.

Не закомментировано:

Закомментировано символами однострочного комментария:

Закомментировано символами многострочного комментария:

Есть несколько причин, зачем использовать закомментирование:

Причина №1: Вы работаете над новой частью кода, которая пока что не рабочая, но вам нужно запустить программу. Компилятор не позволит выполнить программу, если в ней будут ошибки. Временное отделение нерабочего кода от рабочего комментированием позволит вам запустить программу. Когда код будет рабочий – сможете его легко раскомментировать и продолжить работу.

Причина №2: Вы написали код, который компилируется, но работает не так как нужно и сейчас у вас нет времени с этим разбираться. Закомментируйте код, а затем, когда будет время, исправьте в нём ошибки.

Причина №3: Поиск корня ошибки. Если программа производит не те результаты (или вообще происходит сбой), полезно будет поочерёдно «отключать» части вашего кода, чтобы понять какие из них рабочие, а какие создают проблемы. Если вы закомментируете одну или несколько строчек кода и программа начнёт корректно работать (или пропадут сбои), шансы того, что последнее, что вы закомментировали, является ошибкой – очень велики. После этого вы сможете разобраться с тем, почему же этот код не работает так, как нужно.

Причина №4: Тестирование нового кода. Вместо удаления старого кода, вы можете его закомментировать и оставить для справки, пока не будете уверены, что ваш новый код работает так, как нужно. Как только вы будете уверены в новом коде, то сможете без проблем удалить старые фрагменты кода. Если же новый код у вас будет работать не так, как нужно – вы сможете его удалить и выполнить откат к старому коду.

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

Оценить статью:

Звёзд: 1Звёзд: 2Звёзд: 3Звёзд: 4Звёзд: 5 (367 оценок, среднее: 4,96 из 5)
Загрузка...

Комментариев: 7

  1. Аватар Demien:

    Ты забыл о третьем виде коментариев — тройной слеш.

  2. Аватар Александр Казаков:

    Новое понимание комментария. Спасибо! Это другой взгляд или взгляд с другой стороны.

  3. Аватар Testik:

    В третьей части урока мы создаём второй уровень для игры Кот в лабиринте и закрепляем команды Scratch для реализации движения спрайтов по координатам.

  4. Аватар Эзиз:

    Самая легкая тема в программирований)))

  5. Аватар Feliz:

    А почему "ravesli" ?

    1. Юрий Юрий:

      Просто так. Название ни к чему не привязано.

  6. Аватар Денис:

    Спасибо, узнал, что можно "закомментировать"

Добавить комментарий

Ваш E-mail не будет опубликован. Обязательные поля помечены *