Оформление текстов программ
Оформление рисунков, таблиц и формул
Все рисунки, таблицы и формулы нумеруют арабскими цифрами последовательно (сквозная нумерация). В приложении – в пределах приложения (см. далее). Допускается нумеровать рисунки и таблицы в пределах раздела. В этом случае номер состоит из номера раздела и порядкового номера рисунка или таблицы, разделенных точкой. Если рисунок или таблица единственны, то они обозначаются как «Рисунок 1» или «Таблица 1».
На все рисунки и таблицы в записке должны быть ссылки в виде: «диаграмма классов (рисунок 12) …» или «… форма окна основного меню приведена на рисунке 12». Ссылки на таблицы в тексте пояснительной записки должны быть в виде слова «таблица» с указанием ее номера. Например, «Результаты тестов приведены в таблице 4».
Рисунки и таблицы должны размещаться сразу после той страницы, на которой, в тексте записки, она упоминается в первый раз. Если позволяет место, рисунок (таблица) может размещаться в тексте на той же странице, где на него дается первая ссылка.
Рисунки. Все иллюстрации (графики, схемы, диаграммы) именуют рисунками. Они могут быть приведены как в основном тексте, так и в приложении. Иллюстрации могут быть выполнены на компьютере, допустимы цветные иллюстрации. Чертежи, графики, диаграммы, схемы должны соответствовать требованиям ЕСКД и ЕСПД.
Рисунок может иметь наименование и пояснительные данные (подрисуночный текст). Слово «Рисунок» и его наименование располагают посередине строки, причем между ними ставится дефис. По мере необходимости, рисунок может снабжаться поясняющими обозначениями. Если такая подрисуночная подпись есть, то слово «Рисунок» и его наименование помещают после пояснительных данных.
Например:
Рисунок 12 – Интерфейс текстового редактора Word
Если рисунок занимает более одной страницы, на всех страницах, кроме первой, проставляется номер рисунка и слово «Продолжение». Например:
Рисунок 12 - Продолжение
Рисунки следует размещать так, чтобы их можно было рассматривать без поворота записки. Если такое размещение невозможно, рисунки следует располагать так, чтобы для рассматривания надо было повернуть записку по часовой стрелке. В этом случае верхним краем является левый край страницы. Расположение и размеры полей сохраняются в соответствии с установленными.
Толщина сплошной линии при вычерчивании схем должна быть в пределах от 0,6 до 1,5 мм. Надписи на схемах должны быть выполнены чертежным шрифтом. Высота букв и цифр должна быть менее 3,5 мм.
Таблицы. Оформление таблиц должно соответствовать ГОСТ 1.5 и ГОСТ 2.105. Название таблицы, при его наличии, должно отражать ее содержание, быть точным, кратким. Название следует помещать над таблицей слева, без абзацного отступа в одну строку с ее номером через дефис. Заголовок, кроме первой буквы, выполняется строчными буквами, без точки в конце и в единственном числе. В аббревиатурах используются только заглавные буквы. Например: ПЭВМ. Высота строк – не менее 8мм.
Таблицу с большим количеством строк допускается переносить на другой лист (страницу). При переносе слово «Таблица» и ее номер указывается один раз справа над первой частью таблицы, а над другими частями пишут слово «Продолжение» и указывают номер таблицы, например: «Продолжение таблицы 1». При этом заголовок помещают только над ее первой частью, а нижнюю горизонтальную черту, ограничивающую таблицу, не проводят.
Пример оформления таблицы приведен на рисунке 1.
Таблица 1 – Результаты расчета пружины
Главный граф Заголовки граф
Подзаголовки граф
 |
Строки
Колонки
Рисунок 1 - Пример оформления таблицы
Возможно альбомное расположение таблицы. Разбивка головки таблицы по диагонали не допускается.
Формулы. Формулы следует выделять из текста в отдельную строку, расположив ее посередине. Ниже и выше каждой формулы или уравнения должно быть оставлено не менее одной свободной строки. Пояснения значений символов и числовых коэффициентов следует проводить непосредственно под формулой в той же последовательности, в которой они даны в формуле, первое значение - после слова «где» без двоеточия, каждое следующее – с новой строки. Формулы следует нумеровать порядковой нумерацией в пределах записки арабскими цифрами. Номер формулы ставится в крайне правом положении на строке в круглых скобках на уровне формулы. Допускается нумерация в пределах раздела. Например:
z:=sin(x)+ln(y); (12)
Ссылка на номер формулы дается в скобках. Например: «расчет значений производится по формуле (12)».
Примечания. Слово «Примечание» следует печатать с прописной буквы с абзацным отступом и не подчеркивать. Если примечание одно, то после слова «Примечание» ставится тире, примечание печатается с прописной буквы и не номеруется. Несколько примечаний нумеруются по порядку арабскими цифрами со скобкой без проставления точки. Примечание к таблице помещают в конце таблицы над линией, обозначающей окончание таблицы.
Пример одного примечания:
Примечание – _______________________________________________
Пример нескольких примечаний:
Примечания
1) ______________________________________
2)___________________________________
3) ________________________________________
Тексты программ должны оформляться в соответствии с «хорошим стилем» программирования, т. е. должны быть легко читаемы и хорошо документированы. В текстах должны быть комментарии:
1) после заголовка программы или подпрограммы приводится общая информация: назначение, входные данные, результаты, метод решения; данные о программисте, дата написания, версия;
2) при объявлении данных – назначение переменных;
3) в начале и в конце определенной функционально законченной части программы;
4) для пояснения логических частей программы (ветвлений, циклов).
Однако комментарии не должны затенять структуру текста и должны быть ясными и краткими. Наименование программ и подпрограмм должны отражать их назначение. Логическая структура программы должна быть отражена в ее тексте с помощью:
1) пустых строк между текстами подпрограмм и отдельных ее функционально законченных частей;
2) сдвигами текста в строке при написании:
· заголовков вложенных циклов;
· тела цикла после его заголовка;
· альтернатив разветвлений процесса обработки данных.