Оформление программного кода

Оформление иллюстраций, диаграмм и таблиц

Правила представления формул и технических расчетов

Правила записи количественных и порядковых числительных

Однозначные количественные числительные, если при них нет единиц измерения, пишутся словами. Например: «на трех образцах», а не «на 3 образцах».

Многозначные количественные числительные пишутся цифрами, за исключением числительных, которыми начинается абзац, такие числительные пишутся словами.

Числа с сокращенным обозначением единиц измерения пишутся цифрами. Например: 7 л, 24 кг. После сокращения "л", "кг", "b" (байт), и т.п. точка не ставится.

При перечислении однородных чисел (величин и отношений) сокращенное обозначение единицы измерения ставится только после последней цифры. Например: 3, 14 и 25 кг.

Количественные числительные при записи арабскими цифрами не имеют падежных окончаний, если они сопровождаются существительными. Например: на 20 страницах, а не «на 20-ти страницах».

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

Порядковые числительные, входящие в состав сложных слов, в научных текстах пишутся цифрами. Например, 30-процентный раствор. В последние годы все чаще используется форма без наращения падежного окончания, если контекст не допускает двояких толкований, например, в 3% растворе.

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

- одну букву, если они оканчиваются на две гласные, на "й", на согласную букву, например: вторая – 2-я (не: 2-ая), пятнадцатый – 15-й (не: 15-ый или 15-тый), тридцатых – 30-х (не: 30-ых), в 53-м году (не: в 53-ем или 53-ьем году),

- две буквы, если оканчиваются на согласную и гласную буквы. Например, десятого класса – 10-го класса (не: 10-ого класса).

При перечислении нескольких порядковых числительных падежное окончание ставится только один раз. Например, компьютеры 1 и 2-го поколений.

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

Например: в гл. 3, на рис. 2, в табл. 4.

Порядковые числительные при записи римскими цифрами для обозначения порядковых номеров столетий (веков), падежных окончаний не имеют. Например: XX век, а не: ХХ-й век.

Математические формулы и записи расчетов выделяются из текста свободными строками. Выше и ниже должно быть оставлено не менее одной строки (от 6 до 8 мм).

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

Место номера формулы-дроби располагают на середине основной горизонтальной черты формулы по правому краю страницы.

Нумерация небольших формул, составляющих единую группу, делается на одной строке и объединяется одним номером.

Нумерация группы формул, расположенных на отдельных строках и объединенных фигурной скобкой (парантезом), про­изводится справа. Острие парантеза находится в середине группы формул по высоте и обращено в сторону номера, помещаемого против острия парантеза в правом крае страницы.

Формулы-разновидности приведенной ранее основной формулы допускается нумеровать арабской цифрой и прямой строч­ной буквой русского алфавита, которая пишется слитно с цифрой. Например: (14а), (14б).

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

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

Формулы, помещаемые в приложениях, должны обозначаться отдельной нумерацией арабскими цифрами в пределах каждого приложения с добавлением буквы перед каждой цифрой обозначения приложения, например, формула (Б. 1).

При ссылках на какую-либо формулу в тексте ее номер ставят точно в той же графической форме, что и после формулы, т.е. арабскими цифрами в круглых скобках. Например: в фор­муле (3.7); из уравнения (5.1) вытекает...

Если ссылка на номер формулы находится внутри выра­жения, заключенного в круглые скобки, то их рекомендуется заменять квадратными скобками. Например: Используя выра­жение для дивергенции [см. формулу (14.3)], получаем...

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

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

- в тексте перед формулой содержится обобщающее слово;

- этого требует построение текста, предшествующего формуле.

Знаки препинания между формулами, следующими одна за другой и не разделенные текстом, отделяют запятой или точ­кой с запятой. Эти знаки препинания помещают непосредственно за формулами до их номера.

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

Пример.

Начальную влажность образца древесины Wн., %, вычисляют по формуле

, (1)

где – начальная масса образца, г;

– масса образца в абсолютно сухом состоянии, г.

Формулы, следующие одна за другой и не разделенные текстом, разде­ляют запятой.

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

В математических формулах точка как знак умножения не ставится перед буквенными символами, после скобки и перед скобкой; точка ставится между дробями и перед числом, выраженным цифрой, например:

Не допускается в одну строчку с формулой, непосредственно перед ней, писать единицу физической величины. Единица физической величины должна быть указана во фразе, предшествующей формуле, или в расшиф­ровке символов, если такая начинается с пояснения искомой величины.

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

1. Количество теплоты определяется по формуле, в Дж.

2. Диаметр отверстия , мм.

Правильно:

1. Количество теплоты, Дж, определяется по формуле...

2. Диаметр отверстия , мм, .

Все расчеты должны быть выполнены в международной системе единиц.

Числовые значения величин, входящих в формулу, приводят ни­же формулы, за расшифровкой символов.

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

Например:

Коэффициент объемной усушки для древесины сосны , таблица 4.6, [5 с. 50].

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

Для создания формул в текстовом процессоре Microsoft Word следует использовать встроенный редактор формул. Формулы вставлять как встроенные. Не допускается набирать формулы и отдельные величины простым текстом. Редактирование осуществлять только при помощи инструментов табуляции.

Все помещаемые в текстовом документе иллюстрации (различные схемы, эскизы, чертежи, диаграммы, фотографии) именуются рисунками. Оформление иллюстраций осуществляется в соответствии с ГОСТ 2.105 – 95.

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

Иллюстрации помещают в разрыве текста сразу после первой ссылки на нее или на отдельном листе того же формата.

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

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

Рис. 1. Название

Рис. 3.2. Название – второй рисунок третьего раздела.

Иллюстрации каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой знака (буквы) приложения. Например: Рис. А.3.

При выполнении ссылки на иллюстрацию следует писать «…в соответствии с рис. 3.2».

Иллюстрации, при необходимости, могут иметь наименование и пояснительные данные (подрисуночный текст). Слово «Рис.» и его наименование помещают после пояснительных данных.

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

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

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

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

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

Ниже на листе приведены три примера оформления иллюстраций.

Рис. 7. Внешний вид ZyXEL P-660HT3 EE

Рис. 4.1. Внешний вид монитора Samsung LCD 19" E1920NW

Рис. 9.2. Цоколевка корпуса двухтактного ШИМ-контроллера

Одним из видов иллюстраций могут быть диаграммы, т.е. графики, отражающие функциональную зависимость двух или нескольких величин. Диаграммы могут быть построены на основании аналитических расчетов, или путем снятия показаний с регистрирующих приборов. Рекомендуется создавать диаграммы средствами Microsoft Excel 2010.

При составлении диаграммы значения переменной величины, связанной функциональной зависимостью, откладываются по оси ординат. Значения независимой переменной – по горизонтальной оси.

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

На диаграммах со шкалами направления возрастания величин можно обозначать в виде самостоятельных стрелок, расположенных параллельно осям координат.

Значения величин могут изображаться в линейном или логарифмическом масштабах. Масштаб, т.е. шкала значений переменной величины, может быть различным для каждого направления координат.

Числа у шкал следует размещать вне поля диаграммы и располагать горизонтально. Если началом отсчета по оси абсцисс и ординат является нуль, то его следует указать один раз у точки пересечения шкал.

Пример оформления представлен ниже.

Рис. 10. График зависимости свободной энергии F и n_S от доли

целых узлов x (при h=0, N=25, R=2)

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

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

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

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

Начертание диаграммы следует выполнять линиями в соответствии с ГОСТ 2.303 ­– 68. Оси шкал и оси координат – сплошной основной линией толщиной S. Линии координатной сетки и делительные штрихи – сплошной тонкой линией толщиной S/2. Изображение функциональной зависимости (линии графического образа) – линией толщиной 2S.

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

Диаграммы, помещаемые в текстовом документе, должны быть выполнены в соответствии с правилами оформления иллюстраций по ГОСТ 2.105 – 95.

Для сокращения объема текстового документа рекомендуется часть текста с цифрами и расчеты приводить в виде таблиц.

Название таблицы, при его наличии, должно точно и кратко отражать ее содержание, а также место и время, к которому относится событие. Слово «Таблица» пишется над заголовком таблицы и выравнивается по правому краю. Для выравнивания используются инструменты табуляции.

Заголовок таблицы пишется с прописной буквы по центру листа.

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

Таблицы приложений обозначают отдельной нумерацией арабскими буквами с добавлением перед цифрой обозначения приложения. Например: «Таблица В.1».

На все таблицы документа должны быть ссылки в тексте документа, при ссылке следует писать слово «таблица» с указанием ее номера.

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

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

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

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

Таблицы с небольшим количеством граф допускается делить на части и помещать одну часть рядом с другой на одной странице. Головку таблицы необходимо повторять.

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

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

Графу «Номер по порядку» в таблицу включать не допускается. При необходимости нумерация показателей, параметров или других данных, порядковые номера следует указывать в первой графе (боковике) таблицы непосредственно перед их наименованием. Перед числовыми значениями величин и обозначением типов, марок, и т.п. порядковые номера не проставляются. В головке таблице не допускается диагональное деление граф.

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

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

При заполнении таблицы можно использовать условные обозначения:

- «-«-» если в графе текст повторяется. Но следует учесть, что ставить кавычки вместо повторяющихся цифр, марок, знаков, математических и химических символов не допускается;

- «х» если данная позиция (на пересечении соответствующих граф и строк) не подлежит заполнению, или не имеет смысла;

- «…» или «нет сведений» если сведения отсутствуют;

- «-» если отсутствует явление или событие.

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

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

- текст и цифровой материал таблиц выполняется 10 шрифтом;

- в пределах одной графы округление следует проводить с одинаковой степенью точности;

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

Примеры оформления таблиц представлены ниже.

Таблица 11

Конфигурация сетевого оборудования

И.Н. оборудования	Сетевая конфигурация	И.Н. оборудования	Сетевая конфигурация
	Имя в сети: Server Рабочая группа: SRV IP-адрес: 192.168.10.100		Имя в сети: ADSL Рабочая группа: SRV IP-адрес: 192.168.10.103
2-3	Имя в сети: Switch Рабочая группа: SRV IP-адрес: 192.168.10.101-102	5-18	Имя в сети: User 1-13 Рабочая группа: User IP-адрес: 192.168.10.105-118

Таблица 12

Анализ затрат на аппаратную часть СКС

Наименование	Кол-во, шт.	Цена, руб.	Итого, руб.
Сервер Hewlett-Packard ProLiant ML 110G6 G6950	1
Коммутатор HP ProCurve Switch 1700-8G	1
Коммутатор HP ProCurve Switch 1410-16G	1
ADSL2+ маршрутизатор ZyXEL P-660HT3 ЕЕ	1
Персональный компьютер DNS Office	13
	Продолжение табл. 12
Монитор Samsung LCD 19" E1920NW		3500
МФУ Samsung SCX-3200 A4
Кондиционер бытовой: LG S07LHQ
Кондиционер пром.: Samsung AQ09TSBN(X)
Ippon SMART POWER PRO 2000
Общая сумма затрат на аппаратную часть	224717

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

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

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

Программный код, находящийся в документе, следует оформлять шрифтом Courier New, размер – 12 пт, межстрочный интервал – одинарный.

Программный код, находящийся в приложении документа, следует оформлять в две колонки, шрифт – Arial, размер – 8, межстрочный интервал – одинарный.

Дата добавления: 2014-11-18