Правила записи алгоритмов (правила ступенчатой записи). Документирование программы. Комментарии (вводные, пояснительные).

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

Основные правила, задающие псевдокод:

· действия описываются предложениями, помещаемыми в отдельной строке;

· последовательность действий описывается аналогичной последовательностью описывающих их предложений;

· разветвление описывается конструкцией IF-THEN-ELSE;

· завершение разветвления описывается конструкцией END-IF;

· выбор одного из нескольких направлений описывается конструкцией CASE;

· завершение структуры выбора описывается конструкцией END-CASE;

· цикл описывается конструкцией DO-WHILE;

· завершение цикла описывается конструкцией END-DO.

Между словами IF-THEN указывают проверяемое условие, между THEN-ELSE – действие, вполняемое при истинности условия (линия TRUE), между ELSE и END-IF – действие при ложности условия (линия FALSE).

Во вложенных конструкциях разветвления для внешнего IF слово ELSE можно опустить, если действий в этой ветви не предусматривается. Для вложенных IF пустая конструкция ELSE обязательна.

После слова CASE записывается переменная – селектор выбора направления. Затем между селектором и конструкцией END-CASE записывают все возможные значения селектора и соответствующие им действия.

После слов DO-WHILE записывают условие повторяемости действий области цикла, находящейся между условием и словами END-DO.

Для получения наглядности алгоритма в псевдокодах введен ряд правил его изображения:

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

· условия следует записывать в той же строке, что и соответствующие им служебные слова;

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

· вложенные конструкции записывают со сдвигом вправо относительно объемлющих конструкций

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

Последней составляющей процесса программирования является документирование. Оно включает широкий спектр описаний, облегчающих процесс программирования и обогащающих результирующую программу. Постоянное документирование должно составлять неотъемлемую часть каждого шага программирования. Постановка задачи, проектные документы, алгоритмы и программы - все это документы. Внутренняя документация, включенная непосредственно в программу, облегчает чтение кода. Назначение учебного пособия (еще одной формы документации) - научить пользователя применять новую программу; справочное руководство позволяет ознакомиться с описанием команд программного обеспечения.

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

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

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

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

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

Сопровождение - это продолжающаяся разработка, поэтому если созданную программу совершенствуют и обновляют не сами её создатели, то чаще всего привлекают специальную команду разработчиков - сопроводители. Этой команде придется иметь дело с такой же документацией, с той лишь разницей, что им нужно будет подробно просматривать и изучать документацию, созданную первоначальными (основными) разработчиками, с той целью, чтоб понять строение и процесс разработки изменяемой программы, и внести в эту документацию необходимые изменения, повторяя в значительной степени технологический процессы, с помощью которых создавалась первоначальная программа.

Документация по сопровождению программы можно разбить на две группы:

1. документация, определяющая строение программ и структур данных программы и технологию их разработки;

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

Документация первой группы содержит итоговые документы каждого технологического этапа разработки. Она включает следующие документы:

· Внешнее описание

· Описание архитектуры программы, включая внешнюю спецификацию

· Описание модульной системы, включая внешнюю спецификацию каждого включенного модуля

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

Документы второй группы содержат руководство по сопровождению программы, которое описывает известные проблемы вместе с программой, описывает, какие части программы являются аппаратно и программно зависимыми.

Вводные комментарии. Каждая программа, подпрограмма или процедура должна начинаться с комментариев, поясняющих, что она делает. Минимальная информация, содержащаяся в вводных комментариях, должна включать следующие пункты:

1. Назначение программы.

2. Указания по вызову программы и ее использованию.

3. Список и назначение основных переменных или массивов.

4. Указания по вводу-выводу. Список всех файлов.

5. Список используемых подпрограмм.

6. Название применяемых математических методов, а также ссылки на литературные источники, где содержится их описание.

7. Сведения о времени выполнения программы.

8. Требуемый объем памяти.

9. Специальные указания оператору.

10. Сведения об авторе.

11. Дату написания программы.

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

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

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

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

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

Дата добавления: 2015-09-05