2. Правила составления комментариев.

Существует 3 вида комментариев:

• вводные

• оглавления

• пояснительные

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

• имя модуля;

• его назначение;

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

• описание входных и выходных данных;

• перечень используемых подпрограмм;

• описание внешних эффектов;

• ограничения и допущения;

• сведения об авторах;

• дата разработки;

• описание внесённых в ходе сопровождения изменений.

Комментарии оглавления.

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

Содержат:

• перечни модулей;

• краткое описание назначения и указания подчинённости модулей.

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

Пояснительные комментарии.

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

Основное правило составления пояснительных комментариев.

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

Пример:

E=sqrt(u)

Пояснительный комментарий: вычисляется среднее квадратическое отклонение.

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

3. Правило выбора имён.

Имена должны обладать мневмотичностью, т.е. отражать сущность описываемых объектов. В связи с ограничениями на длину переменных при выборе имён сокращению подлежат не более 3-х первых слов. Абравиатура всегда включает начальные буквы слов. Согласные всегда важнее гласных. Начало слова всегда важнее его конца. Абравиатура включает 6–12 букв.

4. Правило обеспечения наглядности логической структуры.

1. Используются дополнительные пробелы для выделения составных частей операторов.

2. Нельзя располагать на одной строке программы. Это облегчает поиск и удаление ошибок, модификацию программы, чтение текста.

3. Всегда надо использовать ( )-ки для пояснения структуры записываемых выражений.

a*b/c*d*e/f

(a*b*d*e)/(c*f)

4. Надо использовать отступы для выявления структуры составных и вложенных операторов.

4. Нисходящее программирование.

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

A-B-C-D-B1-B2-C1-D1-D2-D3

Преимущества нисходящего программирования:

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

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

3. Нисходящее программирование может быть совмещено с выполнением отладки программы нисходящим методом.