7/7 Тема 2.6. Кодирование. Стиль кода программы. Способы документирования кода программы
Краткие теоретические сведения
На этапе кодирование производится перевод псевдокода на какой-либо язык программирования. Как написать красивую программу? Какой должна быть программа, чтобы с ней было легко работать? Разберем эти вопросы более подробно.
Помните, программы читаются людьми
Вряд ли кто-нибудь согласится с тем, что удобочитаемость программ не существенна. Программисты должны быть всегда в состоянии прочесть свои программы. Трудночитаемые программы сложно модифицировать, особенно если это приходится делать не автору программы. Как правило, легче полностью переписать чужую программу, чем ее модифицировать. Когда программист обращается к чужой программе и видит, что она хорошо организована и легкочитаема, то естественные отрицательные эмоции, вызванные необходимостью обновления или модификации этой программы, отступают. Легкочитаемая программа создает впечатление, что ее автор хорошо знал, что делал. Программа должна передавать логику и структуру алгоритма настолько, насколько это возможно.
Если программы составляются для какой-либо организации, то применение согласованного стиля поможет сделать их достоянием этой организации, а не личной собственностью отдельного программиста.
Следуя определенному стилю программирования, можно избежать многих ошибок и трудностей, возникающих при разработке и модификации программ.
В естественном языке для улучшения читаемости текста используются знаки пунктуации, разделение на параграфы, упорядочение и интервалы. Программисты могут пользоваться подобными средствами.
Стандартизация стиля
Правило стандартизации стиля: если существует более одного способа сделать что-либо и выбор произвольный, остановитесь на одном способе и всегда его придерживайтесь.
Например, если Вы работаете с матрицей и в одном месте использовали в качестве индексов переменные i и j, то в других местах программы целесообразно использовать эти же переменные.
Преимущества такого подхода: вы избежите путаницы, сможете сконцентрировать внимание на действительно новых задачах.
Комментарии
Желательность комментариев, казалось бы, очевидна, однако далеко не всегда их включают в программу. Комментарии опускают с целью экономии времени. Иногда утверждают, что "комментарии будут вставлены позже". Но такая отговорка неубедительна, потому что через удивительно короткое время авторы программы обнаруживают, что забыли многие детали.
Программы с пояснительными комментариями значительно легче отлаживать, так как они содержат дополнительную информацию для работы с программой. Просматривая чужую программу, программист часто тратит много времени, отслеживая логику программы или просто переписывая недокументированную программу, если необходимо внести в нее изменения. В этом случае все первоначально "сэкономленное" время расходуется с превышением во много раз.
Одна из причин отсутствия комментариев - переоценка наших возможностей. Мы уверены, что легко вспомним логику той или иной части программы. Более того, мы не ожидаем большого количества ошибок в нашей программе, и комментарии кажутся нам излишними. Однако опыт говорит об обманчивости подобных ожиданий.
Отсутствие комментариев затрудняет тестирование и отладку, а также является свидетельство дилетантского подхода.
Рекомендуется включать комментарии в процессе написания программы. Именно в это время вы в наибольшей степени вникаете во все детали программы. Редко удается получить удовлетворительные результаты при более поздней вставке комментариев: при этом приходится вспоминать, что следует прокомментировать.
Делайте комментариев больше, чем это кажется необходимым.
Существуют три типа комментариев:
вводные,
оглавления,
пояснительные.