ЧЕЛОВЕЧЕСКИЙ ФАКТОР

Стиль программирования

Под стилем программирования понимают неалгорнтмические вариации в использовании программистами средств алгорит­мического языка. В понятие стиля включают использование комментариев, имен переменных, отступов в тексте програм­мы, выбор модулей — т. е. все те особенности, которые совсем или почти совсем не влияют на алгоритм выполнения програм­мы, но в сильной мере определяют, насколько легко разобрать­ся в программе ее автору или постороннему программисту. Среди указанных четырех составляющих стиля программиро-

(а) X : =1827; /-КОММЕНТАРИИ: LVB RIP*/ /*

(б) ПОДПРОГРАММА FACTOR ОТЫСКИВАЕТ ПРОСТЫЕ МНОЖИТЕЛИ ЧИСЛА NUM И ВОЗВРАЩАЕТ ИХ В МАССИВ FACT. ПРИ ВЫЗОВЕ ПОДПРОГРАММЫ FACTOR ПЕРЕМЕННАЯ N ДОЛЖНА СОДЕР­ЖАТЬ ЗНАЧЕНИЕ ДЛИНЫ МАССИВА FACT. ПРИ ВОЗВРАТЕ УПРАВЛЕНИЯ ЗНАЧЕНИЕ N УСТАНАВЛИВАЕТСЯ РАВНЫМ ЧИС­ЛУ НАИДЕННЫХ МНОЖИТЕЛЕЙ ИЛИ НУЛЮ В СЛУЧАЕ ОШИБКИ.

*/

SUBROUTINE FACTOR (NUM, FACT, N)

Рнс. 1.1. Примеры комментариев: A — короткий комментарий плохого стиля; б —более длинный комментарий лучшего стиля.

Вания выбор модулей в наименьшей степени изучен, возможно, из-за трудностей исследования больших программных проек­тов, для которых именно модульность определяет уровень ка­чества программных изделий. Эта область вызывает значи­тельный интерес у исследователей, а некоторые проводимые в настоящее время работы смогут в скором времени восполнить отсутствие конкретных данных [10].

1.2.1. Комментирование

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

Таблица 1.3. Достоинства и недостатки комментариев, выявленные в экспериментах

_ Литературный

Полученные выводы источник

В задаче «ручной» интерпретации программы результаты были лучше при отсутствии комментариев, а наличие комментариев было полезно лишь тогда, когда они были правильными [57]

В задаче «ручной» интерпретации программы комментарии способствовали быстрейшему завершению работы, но при этом увеличивалось количество ошибок [89J

В задачах модификации программ и восстановления их в па­мяти программиста одиночные разъясняющие комментарии (высокого уровня) к каждому модулю давали лучший ре­зультат, чем множество подробных комментариев (низкого уровня) [71]

Комментарии оказались малополезными при работе с корот­кими программами [67]

Мер, на русском), но они могут включать также диаграммы или символические коды. Возможность использования коммен­тариев присуща всем алгоритмическим языкам, однако мнения о достоинствах использования комментариев противоречивы, а наилучший способ комментирования является предметом мно­жества дискуссий. Большинство вводных курсов по программи­рованию для начинающих настоятельно рекомендует использо­вать комментарии, в частности, потому что «комментарии спо­собствуют существенному повышению качества программной документации» [17]. Однако некоторые критики утверждают, что комментарии только нивелируют основной текст программы, мешают при отладке, вводя программиста в заблуждение, и представляют определенную опасность, если их забывают исправлять при внесении изменений в программу. В одной из ранних книг [86] Вайнберг писал: «Кажется, что среди про­граммистов мнения о желательности использования коммента­риев в программах безнадежно разделились. Некоторые из них рассматривают написание комментариев как занятие, от­влекающее внимание и силы от составления исчерпывающей программной документации. Другие, в равной степени опыт­ные и прилежные программисты, отстаивают подробное ком­ментирование, снабжая иногда каждый оператор программы пространными пояснениями». Рассмотрение вопроса о ком­ментировании программ будет продолжено в гл. 5.

Экспериментальные данные о комментировании разноречи­вы, однако известно, что лучше иметь плохие комментарии, чем их вообще не иметь. На практике комментарии более по­лезны в больших программах, чем в малых, и иногда даже

Таблица 1.4. Особенности употребления имен переменны*

_ Литературный

Полученные выводы источник

Іірограммистьі утверждают, что лучше понимают программы С мнемоническими именами переменных, хотя тесты на пони - цание программ этого не подтверждают 189]

Р процессе освоения текста программы немнемонические име­на лучше мнемонических, если все онн предварительно опре­делены 1*541 В процессе освоения текста программы мнемонические имена более полезны в сложных программах, чем в простых [54] Мнемонические имена переменных слабо способствуют пони­манию коротких программ 167J При освоении текста программ, не снабженных комментария­ми, мнемонические имена лучше немнемонических [73], с. 70

Считается необходимым составлять их только для больших сегментов кода (не меньших чем подпрограмма или модуль), см. табл. 1.3.