ГОСТ 19.506-79 Единая система программной документации. Описание языка. Требования к содержанию и оформлению

Наименование документа на русском языке Единая система программной документации. Описание языка. Требования к содержанию и оформлению
Наименование документа на английском языке Unified system for program documentation. Language description. Requirements for contents and form of presentation
Статус документа Действует
Дата ввода в действие документа 01.01.1980
Дата последнего издания документа 04.03.2010
Код КГС Т55
Код ОКСТУ 5004;0019

Настоящий стандарт устанавливает требования к содержанию и оформлению программного документа по описанию языка (программирования, управления заданиями, организации вычислительного процесса и т. п.), определенного ГОСТ 19.101-77.

Стандарт полностью соответствует СТ СЭВ 2097-80.

Изменения

(Измененная редакция, Изм. № 1)

1. Общие положения

1.1. Структура и оформление программного документа устанавливаются в соответствии с ГОСТ 19.105-78.

Составление информационной части (аннотации и содержания) является обязательным.

1.2. Описание языка должно содержать следующие разделы:

  • общие сведения;
  • элементы языка.

Допускается вводить разделы:

  • способы структурирования программы;
  • средства обмена данными;
  • встроенные элементы;
  • средства отладки программы.

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

Изменения

(Измененная редакция, Изм. № 1)

2. Содержание разделов

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

2.2. В разделе «Элементы языка» должно быть указано описание синтаксиса и семантики базовых и составных элементов языка.

2.3. В разделе «Способы структурирования программы» должны быть указаны способы вызова процедур передачи управления и другие элементы структурирования программы.

2.4. В разделе «Средства обмена данными» должно быть приведено описание языковых средств обмена данными (например, средства ввода-вывода, внутреннего обмена данными и т. п.).

2.5. В разделе «Встроенные элементы» должны быть приведены описание встроенных в язык элементов (например, функции, классы и т. п.) и правила их использования.

Изменения

2.2-2.5 (Измененная редакция, Изм. № 1)

Изменения

2.6, 2.7 (Исключены, Изм. № 1)

2.8. В разделе «Средства отладки программы» должны быть: приведено описание имеющихся в языке средств отладки программ, семантики этих средств, даны рекомендации по их применению.

Изменения

(Измененная редакция, Изм. № 1)

2.9. При необходимости содержание разделов должно быть пояснено примерами.

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

Только авторизованные участники могут оставлять комментарии.