ПРИЛОЖЕНИЕ В Перечень нормативно-технической документации, используемой при оформлении программных документов

ЕСПД. Общие положения [Текст]: ГОСТ 19.001–77. - Введ. 1980-01-01. – М.: ИПК Изд-во стандартов, 1980.

ЕСПД. Виды программ и программных документов [Текст]: ГОСТ 19.101–77. - Введ. 1980-01-01. – М.: ИПК Изд-во стандартов, 1980.

ЕСПД. Стадии разработки [Текст]: ГОСТ 19.102–77. - Введ. 1980-01-01. – М.: ИПК Изд-во стандартов, 1980.

ЕСПД. Обозначение программ и программных документов [Текст]: ГОСТ 19.103–77. Введ. - 1980-01-01. – М.: ИПК Изд-во стандартов, 1980.

ЕСПД. Основные надписи [Текст]: ГОСТ 19.104–78. - Введ. 1980-01-01. – М.: ИПК Изд-во стандартов, 1980.

ЕСПД. Общие требования к программным документам [Текст]: ГОСТ 19.105–78. - Введ. 1980-01-01. – М.: ИПК Изд-во стандартов, 1980.

ЕСПД. Требования к программным документам, выполненным печатным способом [Текст]: ГОСТ 19.106–78*. - Введ. 1980-01-01. – М.: ИПК Изд-во стандартов, 1980.

ЕСПД. Техническое задание. Требования к содержанию и оформлению [Текст]: ГОСТ 19.201–78. - Введ. 1980-01-01. – М.: ИПК Изд-во стандартов, 1980.

ЕСПД. Спецификация. Требования к содержанию и оформлению [Текст]: ГОСТ 19.202–78. - Введ. 1980-01-01. – М.: ИПК Изд-во стандартов, 1980.

ЕСПД. Порядок и методика испытаний [Текст]: ГОСТ 19.301–79. - Введ. 1980-01-01. – М.: ИПК Изд-во стандартов, 1980.

ЕСПД. Текст программы. Требования к содержанию и оформлению [Текст]: ГОСТ 19.401–78. - Введ. 1980-01-01. – М.: ИПК Изд-во стандартов, 1980.

ЕСПД. Описание программы [Текст]: ГОСТ 19.402–78. - Введ. 1980-01-01. – М.: ИПК Изд-во стандартов, 1980.

ЕСПД. Пояснительная записка. Требования к содержанию и оформлению [Текст]: ГОСТ 19.404–79. - Введ. 1981-01-01. – М.: ИПК Изд-во стандартов, 1981.

ЕСПД. Формуляр. Требования к содержанию и оформлению [Текст]: ГОСТ 19.501–78. - Введ. 1980-01-01. – М.: ИПК Изд-во стандартов, 1980.

ЕСПД. Описание применения. Требования к содержанию и оформлению [Текст]: ГОСТ 19.502–78. - Введ. 1980-01-01. – М.: ИПК Изд-во стандартов, 1980.

ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению [Текст]: ГОСТ 19.503–79*. - Введ. 1980-01-01. – М.: ИПК Изд-во стандартов, 1980.

ЕСПД. Руководство программиста [Текст]: ГОСТ 19.504–79. - Введ. 1980-01-01. – М.: ИПК Изд-во стандартов, 1980.

ЕСПД. Руководство оператора [Текст]: ГОСТ 19.505–79*. - Введ. 1980-01-01. – М.: ИПК Изд-во стандартов, 1980.

ЕСПД. Описание языка [Текст]: ГОСТ 19.506–79*. - Введ. 1980-01-01. – М.: ИПК Изд-во стандартов, 1980.

ЕСПД. Руководство по техническому обслуживанию. Требования к содержанию и оформлению [Текст]: ГОСТ 19.508–79. - Введ. 1981-01-01. – М.: ИПК Изд-во стандартов, 1981.

ЕСПД. Правила внесения изменений в программные документы, выполняемые печатным способом [Текст]: ГОСТ 19.604–78*. - Введ. 1980-01-01. – М.: ИПК Изд-во стандартов, 1980.

ЕСПД. Схемы алгоритмов, программ, данных и систем. Условные обозначения и правила выполнения [Текст]: ГОСТ 19.701–90. - Введ. 1992-01-01. – М.: ИПК Изд-во стандартов, 1992.

Обеспечение систем обработки информации программное. Термины и определения [Текст]: ГОСТ 19.781–90. - Введ. 1992-01-01. – М.: ИПК Изд-во стандартов, 1992.

ПРИЛОЖЕНИЕ Г Требования и рекомендации к оформлению текста программ
(на примере языка C/C++)

Количество операторов в строке. Для улучшения читаемости исходного текста программы рекомендуется писать не более одного оператора в строке, что вызвано особенностями человеческого восприятия текста. Кроме того, это облегчает пошаговую отладку в символьных отладчиках. Не следует опасаться того, что программа слишком вырастет в длину, так как реальные программы и без того настольно длинны, что несколько “лишних” страниц (или даже десятков страниц) не меняют общую ситуацию. Выигрыш же в читаемости с избытком покрывает увеличение длины.

Неправильно Правильно

————————————————————————————-

int *ptr; ptr = new int [100]; int *ptr;

ptr[0] = 0;

ptr = new int [100];

ptr[0] = 0;

Два оператора в строке вполне допустимы, если второй подчинен первому, причем является единственным подчиненным, например:

for(i=0; i < size; i++); m[i] = 0;

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

x1 = Tr1[0]; y1 = Tr1[1]; z1 = Tr1[2];

x2 = Tr2[0]; y2 = Tr2[1]; z2 = Tr2[2];

x3 = Tr3[0]; y3 = Tr3[1]; z3 = Tr3[2];

Отступы. Правильное использование отступов является ключевым методом обеспечения читаемости. Идея состоит в том, что отступы зрительно показывают подчиненность (иерархию) операторов. При этом директивы препроцессора (#include, #define и т.д.), описания классов, структур, типов, глобальных данных и определения функций всегда имеют наивысший приоритет, то есть начинаются с крайней левой позиции, например:

#include < stdio.h>

#define NAME_SIZE 256