Перечень эксплуатационных документов

⇐ ПредыдущаяСтр 7 из 8Следующая ⇒

Вид эксплуатационного документа	Содержание эксплуатационного документа	Регламентирующие стандарты
Ведомость эксплуатационных документов	Перечень эксплуатационных документов на программу.	ГОСТ 19.507-79.
Формуляр	Основные характеристики программы, комплектность и сведения об эксплуатации программы.	ГОСТ 19.501-78.
Описание применения	Сведения о назначении программы, области применения, классе решаемых задач, применяемых методах, ограничениях для применения, минимальной конфигурации технических средств.	ГОСТ 19.502-78.
Руководство системного программиста	Сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения.	ГОСТ 19.503-79.
Руководство программиста	Сведения для эксплуатации программы.	ГОСТ 19.504-79.
Руководство оператора	Сведения, необходимые для осуществления действий, связанных с выполнением программы вычислительной системой.	ГОСТ 19.505-79.
Описание языка	Описание синтаксиса и семантики языка.	ГОСТ 19.506-79.
Руководство по техническому обслуживанию	Сведения для применения текстовых и диагностических программ при обслуживание технических средств.	ГОСТ 19.508-79.

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

ГОСТ 34.602-89 - техническое задание на создание АС;

ГОСТ 34.201-90 - виды и комплектность документов;

РД 50-34.698-90 - пояснительная записка, схема функциональной структуры, общее описание системы, описание постановки задачи, описание информационного обеспечения системы, описание организации информационной базы, перечень входных сигналов и данных, перечень выходных сигналов/документов, описание программного обеспечения;

ГОСТ 19.201-78 - техническое задание;

ГОСТ 19.402-78 - описание программы;

ГОСТ 19.404-79 - пояснительная записка;

ГОСТ 19.301-79 - программа и методика испытаний.

Способы описания алгоритмов

Разработка алгоритмов является неотъемлемой составляющей процесса программирования.

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

Алгоритмы делят по назначению (управляющие, вспомогательные, для работы с графической информацией, …) , по организации (линейные, разветвленные, циклические), по уровню детализации (обобщенные, определенного уровня детализации, детальные) и некоторым другим признакам классификации.

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

1. Словесный – описание осуществляется на естественном языке.

2. Граф-схема – состоит из вершин (операторов, выполняемых в этой вершине) и дуг, указывающих последовательность выполнения операторов.

3. Логическая схема – операторы записываются в строку слева направо в порядке их естественного выполнения. При выполнении условных операторов альтернативные переходы показываются стрелкой.

4. Матричная схема – используется матрица К*К, где К – число всех операторов. На пересечении строки и столбца указывается 1, если за оператором в строке следует оператор столбца.

5. Р-схема – нагруженный по дугам ориентированный граф, изображаемый с помощью вертикальных и горизонтальных линий и состоящий из структур (подграфов), каждый из которых имеет только 1 вход и 1 выход (ГОСТ 19.005-85)

6. Блок-схема – схема, использующая символы для отображения операций, данных, потока, оборудования и т.д. Правила выполнения схем алгоритмов программ, данных и систем представлены в ГОСТ 19.701 – 90.

7. Алгоритмический язык (псевдокоды) – язык записи структурированных алгоритмов, использующий некоторое ограниченное число слов родного языка программиста.

8. Языки программирования – окончательная запись алгоритма в виде, пригодном для исполнения компьютером.

Представлению процедурных алгоритмов посвящен также стандарт ГОСТ Р ИСО/МЭК 8631-94 «Программные конструктивы и условные обозначения для их представления»(введен 1995—07—01). Он содержит полный текст международного стандарта ИСО/МЭК 8631-94 «Информационная технология. Программные конструктивы и условные обозначения для их представления». Программный конструктив состоит из набора одной или более процедурных частей и управляющей части (может быть задана неявно). Каждая процедурная часть состоит из одной или более операций, которые могут исполняться или быть пустыми (нулевыми). Управляющая часть определяет способ выполнения процедурных частей и состоит из управляющей команды или набора условий. Она инициирует или дезактивирует процедурную часть в зависимости от характера управляющей команды или(и) значений условий. В стандарте представлены конструктивы, принятые в разных странах, в том числе для сравнения приводятся конструктивы в соответствии с ГОСТ 19.701—90.

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

Под стилем программирования (стандартами кодирования) подразумевают набор приемов или методов программирования, которые используют опытные программисты, чтобы получить правильные, эффективные, удобные для применения и легко читаемые программы.

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

Минимальная информация вводных комментариев: 1. Назначение программы; 2. Указания по вызову программы и ее использованию; 3. Список и назначение основных переменных или массивов; 4. Указания по вводу-выводу. Список всех файлов; 5. Список используемых подпрограмм; 6. Название применяемых математических методов, а также ссылки на литературные источники, где содержится их описание; 7. Сведения о времени выполнения программы; 8. Требуемый объем памяти; 9. Специальные указания оператору; 10. Сведения об авторе; 11. Дату написания программы.

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

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

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

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

Ряд требований предъявляется к оформлению.

Использовать перенос литерала не рекомендуется, даже, если это допускается в языке программирования. Перенос оператора лучше осуществлять после знака операции. Одного оператора в строке достаточно (выше удобочитаемость программы; легче выделить разделы; легче обнаружить ошибки, т.к. в сообщении об ошибке указывается №строки). Скобки следует ставить во всех сомнительных случаях.

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

Одинаковый отступ от начала строки указывает на связь между операторами. Используется для групп типа BEGIN … END, циклов, группировки команд, операторов IF, ввода-вывода, записи вложенных процедур. Отступы используются для выявления структуры данных и структуры программы.

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

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

При наименовании файлов рекомендуется взять определенный префикс или суффикс. Его можно использовать в названии младших единиц этого файла. Желательно, чтобы имена файлов содержали слово FILE, а имена записей – RECORD. Указанный прием позволяет различать по префиксам идентичные имена, такие, как поля дат, например: MASTER-DATE, TRANS-DATE, REPORT-DATE. При выборе имен записей имена следует ориентировать на содержание записи, а не на конкретное задание.

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

Следует избегать схожих по виду имен, их неестественных написаний (как phone и fone); подобных по написанию символов (АХ10 и АХIO); употребления слов, которые могут ввести в заблуждение пользователя программы. При использовании различных типов переменных: целых, действительных, символьных – полезно начинать их имена с определенных символов. Например, с С – для комплексных; с I, J, K, L, M, N – для целых.

Числа лучше писать в конце имени переменных. Рекомендуется использовать одну или две цифры метки для идентификации блока, а остальные – для нумерации операторов внутри блока. Чтобы иметь возможность независимого выбора имени параграфов, добавляйте к мнемоническим именам параграфов их номера в порядке следования. Например, имена TEST-LOOP-600, RUN-ERROR-610, REPORT-OUT-620 указывают относительное расположение параграфов в программе. Номера должны предусматривать включение новых параграфов.

При отсутствии ограничения на длину имени, предпочтительны длинные имена, но не длиннее, чем необходимо. Если язык программирования допускает разделитель в именах переменных, его следует использовать: COST-PLUS лучше, чем COSTPLUS.

Существенно облегчит чтение программы введение стандартных сокращений – аббревиатур. Использование стандартных сокращений и стандартных имен переменных особенно предпочтительно, когда коллектив программистов создает одну большую систему. Правила сокращения разработаны М.Джексоном. Каждое значащее слово в имени подлежит сокращению, общее число слов в сокращенном имени должно быть не более трех. В аббревиатуру всегда должны включаться начальные буквы слов. Согласные важнее гласных. Начало слова важнее его конца. Аббревиатура должна включать в себя от 6 до 15 букв. Таким образом, сокращение слова образуется последовательным удалением гласных, начиная с правого конца слова, до тех пор, пока либо все гласные не будут изъяты (кроме первой буквы слова, если она гласная), либо слово не уменьшится до требуемого размера. Если все гласные выброшены, а длина слова все еще превышает заданную величину, то удаляются согласные.

Приложение А

(обязательное)

Дата добавления: 2018-05-12; просмотров: 213; Мы поможем в написании вашей работы!

Поделиться с друзьями:

⇐ Предыдущая 1 2 3 4 5 678 Следующая ⇒

Мы поможем в написании ваших работ!