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

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

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

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

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