Единая система программной документации ОПИСАНИЕ ЯЗЫКА Unified system for program documentation. Language description. Requirements for contents and form of presentation

ГОСТ 19.506-79

Постановлением Государственного комитета СССР по стандартам от 12 января 1979 г. № 74 дата введения установлена

01.01.80

Издание с Изменением № 1, утвержденным в сентябре 1981 г. (ИУС 11-81).

Настоящий стандарт устанавливает требования к содержанию и оформлению программного документа по описанию языка (программирования, управления заданиями, организации вычислительного процесса и т. п.), определенного ГОСТ 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. В приложения к описанию языка могут быть включены дополнительные материалы (формализованные описания языковых средств, иллюстрации, таблицы, графики, формы бланков и т. п.).