Точка после номера и после названия не ставится!

Основные требования к оформлению лабораторных, контрольно-курсовых и курсовых работ

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

Приведенный ниже список требований может быть не полным (необходимо ОБЯЗАТЕЛЬНО следовать методическим указаниям по выполнению работы и ГОСТам).

1. Оформление текста отчета (пояснительной записки)

Листы формата А4, поля: левое 2,5 см, остальные по 1,5 см.

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

Рекомендуемый стиль

- для текста:

шрифт: Times New Roman,

размер: 14,

интервал: полуторный,

выравнивание текста: по ширине,

каждый абзац – с красной строки (отступ слева 1,25 см)

- для заголовков:

Первого уровня

шрифт: Times New Roman, полужирный, все прописные

размер: 14,

выравнивание: по центру

Второго и последующих уровней

шрифт: Times New Roman, полужирный

размер: 14,

выравнивание: по центру

- для текста программы:

шрифт: Courier New,

размер: 11 или 12,

интервал: одинарный,

выравнивание текста: по левому краю,

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

Каждый абзац начинать с красной строки без пропуска строки.

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

Заголовки выравнивать по центру.

Точка в конце заголовка НЕ ставится!

Перед новым разделом пропускать строку или начинать с новой страницы.

2. оформление рисунков

1) Под каждым рисунком должна быть подрисуночная подпись.

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

Рекомендуемый стиль: Times New Roman, 12, одинарный интервал.

3) Формат подрисуночной подписи:

Рисунок <номер_рисунка> – <Название_рисунка>

Точка после номера и после названия не ставится!

4) Не должно быть двух рисунков с одинаковыми номерами и/или одинаковыми названиями

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

Примеры правильных подрисуночных подписей:

Рисунок 1 – Пример работы программы сортировки массива методом пузырька

Рисунок 2.3 – График подынтегральной функции

Рисунок 3 – Схема алгоритма ввода данных

Рисунок 4.4 – Схема алгоритма решения системы линейных алгебраических уравнений методом Гаусса

Рисунок 5 – Схема алгоритма нахождения среднего арифметического n чисел

Примеры НЕправильных подрисуночных подписей(ошибки выделены красным):

Рисунок 1 – Пример работы программы // слишком общее название

Рисунок 1. – пример работы программы сортировки массива методом пузырька.

Рисунок 3.4 – Схема алгоритма программы, сортирующей массив

(правильный вариант: Схема алгоритма сортировки массива методом <название_метода>)

Рисунок 3.4 – Схема алгоритма процедуры Vvod

(правильный вариант: Схема алгоритма ввода данных с клавиатуры)

Рисунок 3.4 – Схема функции Obrabotka

(пример правильного варианта названия: Схема алгоритма нахождения наибольшего общего делителя двух чисел)

6) Каждому рисунку должно предшествовать его упоминание в тексте работы. Такое упоминание должно быть персональным для каждого рисунка, осмысленным, распространенным и располагаться максимально близко к рисунку (желательно, на той же странице, или, в крайнем случае, на предыдущей).

Примеры ссылок на рисунки и соответствующих подрисуночных подписей:

1) Общий вид графика подынтегральной функции представлен на рисунке 1.

Рисунок 1 – График подынтегральной функции

2) На рисунке 2 представлена схема алгоритма нахождения максимального элемента в массиве из n чисел. Входными данными здесь является массив вещественных чисел, а выходными – номер элемента массива, соответствующего максимальному числу. В случае, если в массиве присутствует два или более одинаковых максимальных элемента, то в качестве результата выдается номер первого найденного.

Рисунок 2 – Схема алгоритма нахождения максимального элемента в массиве из n чисел

3) На рисунке 3 приведен снимок экрана при работе программы для вычисления наибольшего общего делителя n чисел.

Рисунок 3 – Пример работы программы для вычисления наибольшего общего делителя n чисел

3. Оформление Текста программы

1) Тексту программы должен предшествовать текст с указанием предназначения программы, используемого метода решения задачи (если применимо) и языка, на котором она написана (см. пример 3.1).

Пример 3.1

Ниже следует текст программы на языке программирования Turbo Pascal 7.0 для нахождения интеграла функции, заданной графически по методу левых прямоугольников.

2) Единый стиль оформления (шрифт, размер, выравнивание) для всей работы.

Рекомендуемый стиль:

Courier New, 11 или 12, одинарный интервал, выравнивание по левой границе.

3) Необходимо использовать осмысленные имена переменных, подпрограмм, программ и модулей.

Примеры хороших имен:

function MatrixSummation(…); // функция сложения матриц

procedure SortByMax(…); // процедура сортировки массива по возрастанию

var num_colls: integer; // число столбцов матрицы

var InputFileName: string; // имя файла с входными данными

function Print2DMatrixToScreen(…); // функция вывода на экран двухмерного массива

Примеры плохих имен:

procedure Processing(…); // слишком общее имя – не понятно ни что обрабатывается, ни как

procedure Vvod(…); // транслитерация с русского языка. Для программиста из Великобритании такое название будет лишено смысла

var aaa: integer; // лишенное смысла имя

var my_array: array of integer; // слово “my” не несет информации, лучше указать предназначение массива

Традиционные имена для счетчиков циклов: i, j, k, p, t, s (а также i1, i2, j1, j2 ,…). Их не рекомендуется использовать для каких-либо других целей.

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

4) Зарезервированные слова желательно выделять жирным шрифтом (см. примеры 3.2 и 3.3)

Рекомендуемый стиль:

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

Имена констант писать полностью большими буквами.

Пример 3.2

FunctionSaveToFile( file_name: String, radius: Real, square: Real ): bool;

const MAX_SIZE_OF_ARRAY = 100;

var number: integer;

Begin

number : = 1;

end.

5) Если требуется использовать какие-то величины, неизменяемые в программе (например, размер статического массива), необходимо вводить константы. Использование чисел в тексте программы – плохой стиль программирования.

Пример 3.3

const MAX_SIZE_OF_ARRAY = 100;

Var

my_array1 : array[0…MAX_SIZE_OF_ARRAY] of real; // правильно

my_array2 : array[1…100] of real; // НЕ правильно

i, size : integer;

begin

for i:=1 to size do … // правильно

for i:=1 to 7 do … // не правильно

end.

6) Текст программы должен быть отформатирован с использованием отступов (см. пример 3.4)

Пример 3.4 (правильно) Program FormatExample; // программа… type … var a,b : real; // границы интервала // интегрирования … // -------------------------------------- function Sqare(…); begin … end; // -------------------------------------- procedure OutputData (…); begin … end; // --------------------------------------   // основная часть программы begin … repeat if(a>b ) thenWriteln (’ левая граница интервала интегрирования должна быть больше правой’); if(…) then begin … for (…) do begin …   end; … else begin repeat … until (…); end; until (…); end. Пример 3.4 (не правильно) Program FormatExample; // программа… type … var a,b : real; // границы интервала // интегрирования … // -------------------------------------- function Sqare(…); begin … end; // -------------------------------------- procedure OutputData (…); begin … end; // --------------------------------------   // основная часть программы begin … // не правильно repeat if(a>b ) thenWriteln (’ левая граница интервала интегрирования должна быть больше правой’); if(…) then begin … for (…) do begin …   end; … else begin repeat … until (…); end; until(…); end.  

7) Текст программы должен содержать комментарии по следующим аспектам:

- предназначение подпрограммы, входные и выходные данные, возвращаемое значение

- предназначение всех используемых переменных

- пояснение выполняемых действий

(см. пример 3.5)

Пример 3.5

Program IntegralLeftRect;

// программа для вычисления интеграла функции заданной графически методом

// левых прямоугольников

var a,b,c : real; // параметры функции

integral: real; // интеграл

eps: real; // точность

n: integer; // число подынтервалов разбиения

Begin

// ввод исходных данных

// нахождение значения интеграла с точностью eps

Repeat

// вычисление интеграла при разбиении на n подынтервалов

until (…) // продолжать итерации, пока разность значений интеграла

// при разбиении на n и 2n подынтервалов не станет меньше

// заданной точности

// вывод результатов на экран

End.

4. Оформление Таблиц

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

Формат:

Таблица <Номер_таблицы> - <Название>

5. Схемы алгоритмов

1) Пропорции блоков должны соответствовать ГОСТам. (см. методические указания)

2) Размеры должны быть едиными для всего документа

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

4) Цикл необходимо полностью умещать на одной странице, в одном ‘столбце’. Для этого можно, например, циклы (особенно большие) начинать с новой страницы или, по крайней мере, сверху текущей страницы.

5) Не должно быть пересекающихся линий

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

8) Все блоки должны быть заполнены, в том числе и межстраничные соединители

Пример 5.1. Использование межстраничных соединителей
Точка после номера и после названия не ставится! - student2.ru здесь m – номер следующего блока, n – номер страницы, на которой этот блок находится Правильно Точка после номера и после названия не ставится! - student2.ru ПримерыНЕправильного использования межстраничных соединителей
Пример 5.2. Нумерация блоков Нумерация блоков обязательна в случае, если используются соединители. Номера должны быть проставлены во всех блоках, на одинаковом расстоянии от левого края блока в небольшом разрыве линии
Точка после номера и после названия не ставится! - student2.ru Точка после номера и после названия не ставится! - student2.ru Точка после номера и после названия не ставится! - student2.ru Правильно Точка после номера и после названия не ставится! - student2.ru Точка после номера и после названия не ставится! - student2.ru Точка после номера и после названия не ставится! - student2.ru Не правильно
Пример 5.3. Соединение блоков Не должно быть слишком длинных и ломаных линий, т.е. надо выбирать такой вариант соединения блоков, чтобы соединительные линии были максимально короткие и имели минимальное количество изгибов.
Точка после номера и после названия не ставится! - student2.ru   Правильно Точка после номера и после названия не ставится! - student2.ru Не правильно (надо выбирать такой вариант соединения блоков, чтобы линии были максимально короткими)
Пример 5.4. Оформление блоков ветвления Подписи должны располагаться достаточно близко к ветвям и блоку ветвления, сверху от горизонтальной или справа от вертикальной линии. Подписи должны быть на русском языке.
Точка после номера и после названия не ставится! - student2.ru Точка после номера и после названия не ставится! - student2.ru Правильно Точка после номера и после названия не ставится! - student2.ru Точка после номера и после названия не ставится! - student2.ru Не правильно

6. пРОГРАММА

1. Программа должна включать следующие элементы:

а) Приветственное сообщение, поясняющее предназначение программы

б) Ввод исходных данных с клавиатуры и/или из файла. При этом необходимо производить проверку на корректность введенных пользователем данных:

- проверка на соответствие типа введенных данных ожидаемому типу

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

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

без повторного ввода и вычислений (например, по нажатию клавиши Esc)

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

Пример:

“Введите размер массива [0,..,100], N = ”

“Введите первый элемент массива (вещественное число) A[1] = ”

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

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

Пример:

Были введены следующие данные:

Количество строк в массиве: 2

Количество столбцов в массиве: 3

Массив:

2.0 -3.0 5.2

-1.2 2.4 7.1

Нажмите пробел для повторного ввода данных, «Enter» - для продолжения работы или «Esc» - для выхода из программы

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

2. Программа должна быть разбита на подпрограммы (начиная с ЛР «Подпрограмма-процедура»). Разбиение должно быть осмысленным. При решении любой задачи обязательно должны быть выделены, по крайней мере, 3 подпрограммы: ввода данных, обработки и вывода результатов. Если какая-либо из этих подпрограмм имеет сложную структуру, в ней необходимо выделить отдельные законченные по смыслу фрагменты и оформить их как подпрограммы.

Подпрограммы имеет смысл выделять, если

- они упрощают структуру и, соответственно, понимание программы в целом,

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

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

Наши рекомендации