6.13. Текст программы

Документ состоит из одной или нескольких частей, которым дают наименования.

Допускается вводить наименования и для совокупности частей.

Каждая из этих частей реализуется одним из типов символической записи, например:

• символическая запись на исходном языке;

• символическая запись на промежуточных языках;

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

В начале каждой части документа рекомендуется указывать:

• назначение части;

• содержание части;

• процедуры, функции и другие компоненты программы, которые включены в данную часть, место их использования.

В первой части дополнительно рекомендуется приводить:

• наименование программы;

• обозначение программы;

• используемые для написания программы языки программирования;

• перечень и краткое описание выполняемых функций;

• перечень обозначений функций и процедур, которые включены в данную программу;

• перечень обозначений и краткое описание используемых функций и процедур, вызываемых из других программ или системных библиотек;

• перечень и типы глобальных переменных и констант;

• правила образования имен (идентификаторов) переменных, констант, функций, процедур или ссылка на документ, в котором эти правила установлены;

• перечень входных и выходных данных с пояснением их смысла в терминах предметной области, для использования в которой предназначена программа.

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

При реализации модулей, функций, процедур и других компонентов программы необходимо соблюдать следующие правила:

• обращения к одной функции в разных частях программы должны использовать единый способ восстановления информации вызвавшей ее программы;

• процедуры возврата управления из функций и процедур должны быть единообразными;

• программы, написанные на одном языке программирования, должны использовать единый способ восстановления информации вызвавшей ее программы;

• процедуры и функции, написанные на одном языке, должны единообразным способом передавать значения в вызвавшую их процедуру или функцию;

• каждая функция и процедура должны иметь одну точку входа и одну точку выхода;

• в циклах для параметра, начального и конечного значений диапазона его изменения должны быть использованы переменные одного типа;

• каждый цикл должен иметь один вход и один выход;

• не следует использовать «бесконечные» циклы;

• число переходов по условию должно быть минимизировано;

• не следует использовать условные операторы и циклы с большой глубиной вложенности;

• не следует использовать операторы безусловной передачи управления, особенно если они нарушают направление выполнения операторов;

• в логических (булевых) выражениях переменные и соответствующие им операции следует располагать в порядке уменьшения их влияния на возможность получения отрицательного результата;

• каждая глобальная переменная должна быть объявлена явно во всех модулях, где она используется.

В символическую запись модулей, функций, процедур и других компонентов программы рекомендуется включать комментарии:

• к определениям функций и процедур;

• к интерфейсам;

• к группам функционально или каким-либо другим способом связанных описаний;

• к труднопонимаемым частям программы;

• к операторам ветвления;

• к машинозависимым частям программы;

• к точкам выхода из функций и процедур.

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

При реализации модулей, функций, процедур и других компонентов программы на исходном языке программирования рекомендуется соблюдать следующие правила:

• в одной строке должен быть записан не более чем один оператор;

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