Дробные числа необходимо приводить в виде десятичных дробей, за исключением размеров в дюймах, которые следует записывать 1/4"; 1/2";

При невозможности выразить числовое значение в виде десятичной дроби, допускается записывать в виде простой дроби в одну строчку через косую черту, например, 5/32; (50А - 4С)/(40В + 20).

Количественное числительное, записанное арабскими цифрами и названное вместе с существительным, не имеет падежного окончания, например:

в 10 параграфе.

Порядковые числительные, однозначные и многозначные, как правило, пишутся словами, например:

третий ряд;

пятнадцатый разряд.

Порядковые числительные, входящие в состав сложных слов, а также в научных текстах пишут цифрами, например:

5-тонный грузовик.

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

9-я улица Соколиной горы;

50-й том;

в 90-м году.

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

слесарь 2-го разряда.

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

абзац 3;

гл. 1.

Порядковые числительные, записанные римскими цифрами, не имеют падежных окончаний, например:

ХХ век

8. Требования к оформлению приложений

Приложение оформляют как продолжение данного документа на последующих его листах или выпускают в виде самостоятельного документа.

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

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

Приложения обозначают заглавными буквами русского алфавита, начиная с А, за исключением букв Ё, З, Й, О, Ч, Ь, Ы, Ъ. После слова «Приложение» следует буква, обозначающая его последовательность.

Допускается обозначение приложений буквами латинского алфавита, за исключением букв I и O.

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

Если в документе одно приложение, оно обозначается «Приложение А».

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

Приложения должны иметь общую с остальной частью документа сквозную нумерацию страниц. При необходимости такое приложение может иметь «Содержание».

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

Примечание - в приложении Ж приведена «Сводная таблица унифицированных требований к оформлению студенческих работ».

Перечень нормативно-технической документации, используемой при оформлении программных документов

ЕСПД. Общие положения [Текст] : ГОСТ 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.

Приложение 1

Требования и рекомендации к оформлению текста программ (на примере языка C/C++)

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

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

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

int main()

{ ...

}

При использовании отступов придерживаются следующих правил:

Правило 1. Операторы одного уровня иерархии должны иметь равный отступ:

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

Правило 3. Размер сдвига должен быть постоянным:

Размер сдвига не должен быть ни слишком мал, ни слишком велик. Оптимальная величина составляет 2-5 пробелов. Наиболее часто для сдвигов используют табуляцию, устанавливая при этом для нее желаемый шаг. Последняя возможность поддерживается большинством интегрированных сред разработчика.

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

int factorial( int n ) { if( n > 1 ) return n * factorial( n-1 ); if( n < 0 ) { fprintf( stderr, “Factorial error: negative argument\n” ); return -1; //Заведомо невозможный результат } return 1;

}

Второй подход показан на том же примере:

int factorial( int n )

{ if( n > 1 ) return n * factorial( n-1 ); if( n < 0 ) { fprintf( stderr, “Factorial error: negative argument\n” ); return -1; //Заведомо невозможный результат } return 1;

}

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

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

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

int a, size;

char *buf;

float lenght1, lenght2;

a = 1;

lenght1 = GetLength();

lenght2 = 0;

size = (int) lenght1;

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

1) определения переменных:

char str[80];

int counter = 0;

fgets( str, 79, infile);

counter++;

2) последовательности однотипных инструкций или директив:

#include <math.h>

#include <stdio.h>

#include <stdlib.h>

#define NAME_SIZE 256

#define MAX_LEN 3000

3) функции:

int main()

{

}

char *get_name(FILE *f)

{

}

4) любые логически завершенные блоки кода:

printf( “Enter size and delta: “ ); //Блок ввода данных

scanf( “%d”, &size );

scanf( “%f”, &delta );

for( i=0; i<size; i++ ) //Блок использования данных

{ a[i] -= delta; b[i] += delta;

}

Имена. Типичной ошибкой начинающих является стремление давать всем переменным неосмысленные однобуквенные имена, например m, n, a, s, p и т.п. Это глубоко порочная практика, поскольку при этом теряется сам смысл понятия имя. Однобуквенные имена принято давать только индексам. Исключением являются случаи, когда количество переменных в процедуре очень мало (порядка 1-3 переменных) и смысл их хорошо понятен из контекста или комментариев. Пример - описанная выше функция factorial.

Все переменные, имеющие сколько-нибудь важное значение в программе, необходимо снабжать именами, в той или иной мере характеризующими их назначение, например, filename (имя файла), int_vector (целочисленный вектор), size (размер), sum (сумма), maximum (максимум) и т.п. При плохом знании английского языка можно использовать звуковые аналоги русским буквам, например nazv_faila, razmer, summa и т.п. Это не в полной мере соответствует представлению о “хорошем стиле”, но, несомненно, гораздо нагляднее использования совсем бессмысленных имен. Еще в большей мере сказанное относится к именам функций и классов. Такие имена часто делают довольно длинными для улучшения понимаемости их смысла, а отдельные компоненты имен начинают с большой буквы, например ObjectList, ArcSet и т.п. Имена функций при этом рекомендуется начинать с глагола, например GetPersonName, SetNewDate и т.п. Альтернативным способом выделения компонент в сложных названиях является использование символа подчеркивания, например add_record, copy_object и т.п.

Все сказанное вполне относится и к именам файлов с программами. Имена файлов должны нести обязательную смысловую нагрузку, поясняя свое “содержимое”. Например, заголовочный файл, содержащий описание класса vector логичнее всего назвать vector.h или vector_description.h, а файл, содержащий реализацию методов этого класса - vector.cpp или vector_implementation.cpp. Все современные операционные системы (UNIX, Windows 95/98/NT и т.д.) поддерживают длинные имена файлов, вследствие чего искусственно упрощать и укорачивать их нет необходимости. Более того, при разработке крупного продукта количество исходных файлов измеряется сотнями. В этой ситуации невозможно “помнить”, в каком файле что находится, а значит, длинные и понятные имена жизненно необходимы. Появляется также необходимость организации хранения файлов в виде дерева. В этом случае указанные в примере файлы могут храниться в отдельном подкаталоге vector и именоваться

vector\vector.h и vector\vector.cpp.

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

size = 10; //Присвоить size значение 10

for( i=0; i<size; i++) //Цикл по i от 0 до size

{

}

Такого рода комментарии только загромождают программу.

Комментировать следует:

1) заголовок файла, описывая содержимое данного файла;

2) заголовок функции, поясняя назначение ее аргументов и смысл самой функции;

3) вводимые переменные и структуры данных;

4) основные этапы и особенности реализуемых алгоритмов;

5) любые места, которые трудны для быстрого понимания, в особенности использование различных программных “трюков” и нестандартных приемов.

Приложение 2

Обязательны для применения студентами, преподавателями, организаторами учебного процесса

Размещено на Allbest.ru