Стандарт ГОСТ 19.401-78 ЕСПД. Текст программы. Требования к содержанию и оформлению. Объяснение простым языком

Краткое назначение стандарта ГОСТ 19.401-78 ЕСПД. Текст программы. Требования к содержанию и оформлению

ГОСТ 19.401-78 определяет, как правильно оформлять и что должно входить в документ «Текст программы». Сам документ состоит из разделов – их может быть один или несколько. Код в них может быть написан на исходном, промежуточном языке или в машинных кодах, и его обязательно нужно дополнять комментариями. При этом делать информационную часть (аннотацию и описание функций) для программ на исходном языке нужно в обязательном порядке.

Область применения стандарта ГОСТ 19.401-78 ЕСПД. Текст программы. Требования к содержанию и оформлению

Требования стандарта ГОСТ 19.401-78 распространяются на программы и программные комплексы, которые разрабатываются по правилам Единой системы программной документации (ЕСПД) для любых вычислительных машин и систем.

Основные термины в стандарте ГОСТ 19.401-78 ЕСПД. Текст программы. Требования к содержанию и оформлению

Вот главные понятия, которые используются в стандарте:

• Текст программы – это программный документ, в котором записана сама программа (на исходном или промежуточном языке, либо в машинных кодах) с поясняющими комментариями.
• Информационная часть – обязательный блок, который включает аннотацию и оглавление. Если программа написана на исходном языке, в аннотацию обязательно добавляют краткое описание её функций.
• Основная часть – сам код программы, разделенный на один или несколько разделов с названиями. Название можно дать и группе разделов целиком.
• Символическая запись на исходном языке – один из вариантов оформления разделов программы.
• Символическая запись на промежуточных языках – еще один вариант оформления разделов.
• Символическое представление машинных кодов – вариант записи разделов на уровне машинных команд.
• Комментарии – пояснения к коду, которые помогают понять его структуру и назначение, их рекомендуется добавлять в разделы программы.

Краткое содержание стандарта ГОСТ 19.401-78 ЕСПД. Текст программы. Требования к содержанию и оформлению

ГОСТ 19.401-78 входит в комплекс стандартов ЕСПД и регламентирует создание документа «Текст программы». Документ полностью соответствует международному стандарту СТ СЭВ 3746-82.

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

Типы символической записи в разделах
Каждый раздел программы оформляется в одном из следующих видов:
* символическая запись на исходном языке программирования;
* символическая запись на промежуточных языках;
* символическое представление машинных кодов и т. д.

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

Часто задаваемые вопросы (FAQ) по стандарту ГОСТ 19.401-78 «ЕСПД. Текст программы. Требования к содержанию и оформлению»

1. Что представляет собой стандарт ГОСТ 19.401-78 и каково его главное назначение?

Ответ: Это государственный стандарт из системы ЕСПД. Он задает единые правила для разработчиков: как именно нужно оформлять и что включать в документ под названием «Текст программы».

2. С какими международными стандартами гармонизирован данный документ?

Ответ: ГОСТ 19.401-78 полностью дублирует требования международного стандарта СТ СЭВ 3746-82.

3. Является ли обязательным включение информационной части в состав документа «Текст программы»?

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

4. Какие требования предъявляются к аннотации текста программы на исходном языке?

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

5. Каковы требования к структуре основной части текста программы?

Ответ: Основная часть должна состоять из разделов (одного или нескольких), у каждого из которых должно быть своё название. Также разрешается давать общее название группе разделов.

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

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

7. Как регламентируется использование комментариев в тексте программы?

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

8. Какими нормативными документами регулируются общая структура и оформление документа?

Ответ: Оформление и общая структура «Текста программы» настраиваются по общим стандартам ЕСПД (например, по ГОСТ 19.105-78).

9. Какую практическую роль играет документ «Текст программы» в жизненном цикле программного изделия?

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