КОММЕНТАРИИ. Желательность комментариев, казалось бы, очевидна, однако далеко не всегда их включают в программу

Желательность комментариев, казалось бы, очевидна, однако далеко не всегда их включают в программу. Комментарии опуска­ют с целью экономии времени. Иногда утверждают, что «коммен­тарии будут вставлены позже». Но такая отговорка неубедитель­на, потому что через удивительно короткое время авторы програм­мы обнаруживают, что забыли ее многие детали. Программы с по­яснительными комментариями значительно легче отлаживать, так как они содержат дополнительную информацию для работы с про­граммой. Просматривая чужую программу, программист часто тра­тит много времени, отслеживая логику программы или просто пе­реписывая недокументированную программу, если необходимо вне­сти в нее изменения. В этом случае все первоначально «сэконом­ленное» время расходуется с превышением во много раз.

Некомментируемая программа — это, вероятно, наихудшая ошибка, которую может сделать программист, а также свидетель­ство дилетантского подхода (пусть даже программист имеет деся­тилетний опыт работы); более того, это веская причина для уволь­нения программиста. Последнее утверждение может показаться слишком сильным, но, вероятно, многие руководители одобрили бы его. Комментарии подобны ориентирам в незнакомом лесу. Только неразумный не оставляет ориентиров, затрудняя таким образом отладку и тестирование программы.

Делайте комментариев больше, чем это кажется необходимым.

Хорошие комментарии написать непросто. Так как цель ком­ментариев — облегчить понимание программы, — они должны быть так же хорошо продуманы и проработаны, как и кодировка про­граммы. Существуют три типа комментариев: вводные, оглавления и пояснительные.