Спецификации записи функций и процедур

Имена процедур и функций всегда должны начинаться с прописной буквы. С прописных букв также должны начинаться и составные части имен – это облегчит восприятие. Например:

procedure плохоеимяпроцедуры; // неправильно

procedure ХорошееИмяПроцедуры; // правильно

 

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

 

procedure CreateFileName;

 

Для формирования названия имеются стандартные функциональные пары (см. табл.9).

 

 

Таблица 9. Стандартные функциональные пары.

Функциональная пара	Назначение
Init/Term	инициализация и завершения модуля
Create/Destroy	создание и удаление объекта
Start/Stop	начало/завершение какого-либо процесса
Load/Save	загрузка/выгрузка чего-либо
Get/Set	чтение/установка чего-либо

 

 

Желательно не смешивать функции из разных пар (например, Get/Save – неправильно).

Спецификации записи типов

Имена типов должны отвечать назначению типа. Имя типа должно начинаться с буквы «T», которая служит для указания определения типа, например:

 

Type

T Customer = сla ss (T Object)

Спецификации записи определения классов

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

Имена свойствам определять путем отбрасывания префикса «F» у соответствующего поля класса.

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

 

Пример:

 

TUserMenuItem = class (TCollectionItem)

Private

FVisible: Boolean;

Protected

procedure SetVisible(const AValue: Boolean);

Public

property Visible: Boolean read FVisible write SetVisible;

end;

 

 

Требования к заключению

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

Заключение должно отражать:

- оценку общего состояния объекта исследования и/или оценку изученности исследуемой проблемы;

- итоги анализа изучаемой проблемы в организации;

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

Требования к списку используемых источников

Примеры оформления списка литературы даны в разделе «Список литературы». Заголовок «Список литературы» следует оформлять как заголовок первого уровня. Общие правила литературных ссылок в тексте и оформления списка литературы состоят в следующем:

· список литературы является нумерованным, начиная с 1, в порядке следования ссылок;

· в тексте записки ссылки на литературные источники даются в квадратных скобках, при этом НЕ ставится пробел как после открывающей скобки, так и перед закрывающей скобкой;

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

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

· допустимы ссылки на WEB-страницы;

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

· фамилия и инициалы всех авторов;

· название статьи (без кавычек);

· после названия статьи точки не ставится, а следуют пробел и две косые черты //, после которых следует пробел и указывается название журнала (без кавычек);

· после названия журнала ставится точка и указываются год издания (после него – точка);

· номер тома (после него – запятая);

· номер журнала (после него – точка);

· страницы (первая и последняя, через тире после них ставится точка).

При ссылке на книгу указываются:

· последовательно фамилии и инициалы авторов;

· название книги (без кавычек);

· после названия книги ставится точка и указывается город издания (при этом для Москвы используется сокращение М., для Ленинграда – Л., для Санкт-Петербурга – СПб., для Киева – К.);

· далее ставится двоеточие и указывается название издательства (без кавычек);

· затем ставится запятая и указывается год издания (после него – точка);

· количество страниц в книге.

Примером оформления ссылок на книги является пример. Если у книги более трех авторов, то сначала указывается название книги, далее ставится пробел и одна косая черта /, после нее – пробел и слова «Под ред.» (или “Ed. by” в англоязычной ссылке), после чего следуют инициалы и фамилия редактора (редакторов), далее ставится точка, указывается город издания и т.д.

При ссылке на статью в сборнике трудов или отдельную главу в книге указываются:

· фамилии и инициалы авторов;

· название статьи (главы) без кавычек;

· после чего ставится пробел и две косые черты //;

· затем – пробел и название сборника трудов (книги) без кавычек;

· после названия книги ставится точка и указывается город издания;

· далее ставится двоеточие и указывается название издательства (без кавычек);

· затем ставится запятая и указывается год издания (после него – точка);

· далее указываются страницы, на которых расположена данная статья (глава).

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

Ссылка на WEB-страницу оформляется в соответствии с примером ссылки.

 

Требования к приложениям

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

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

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

Каждое приложение следует начинать с новой страницы с указанием наверху посередине страницы слова «ПРИЛОЖЕНИЕ» и его обозначения, а под ним в скобках для обязательного приложения пишут слово «обязательное», а для информационного — «рекомендуемое» или «справочное».

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

Приложения обозначают заглавными буквами русского алфавита,
начиная с А, за исключением букв 3, О, Ч, Ь, Ы, Ъ. После слова
«ПРИЛОЖЕНИЕ» следует буква, обозначающая его последовательность.

В случае полного использования букв русского и латинского алфавитов допускается обозначать приложения арабскими цифрами. Если в документе одно приложение, оно обозначается «ПРИЛОЖЕНИЕ А».

Приложения, как правило, выполняют на листах формата А4. Допускается оформлять приложения на листах формата A3, А4хЗ, А4х4, А2, А1 по ГОСТ 2.301-68.

Приложения к дипломному проекту оформляются в виде:

- графической части (приложение по выбору)

- графической части в электронном виде (приложение по выбору)

- творческой работы (приложение по выбору)

- презентации дипломного проекта (приложение по выбору)

- вспомогательного материала (обязательное приложение)

 

ОСНОВНЫЕ ТРЕБОВАНИЯ К ОФОРМЛЕНИЮ ДИПЛОМНЫХ ПРОЕКТОВ

 

Текстовые документы выполняют одним из следующих способов:

- рукописным — чертежным шрифтом по ГОСТ 2.304 с высотой букв и цифр не менее 2,5 мм. Текст пишется аккуратно черными чернилами или пастой с расстоянием между строчками 8 мм. Весь текст должен быть написан чернилами (пастой) одного цвета и оттенка.

Расстояние от рамки до границ текста в начале строки 5 мм, в конце строк — не менее 3 мм. Расстояние от верхней или нижней строки текста до верхней или нижней рамки должно быть не менее 10 мм.

При применении компьютера устанавливаются следующие поля:
верхнее 1,5 см правое 1 см; нижнее 3 см и левое 2,5 см. Текст рукописи должен быть набран на компьютере в любом текстовом редакторе с 1,5 межстрочным интервалом (до 40 строк на странице).Работа должна быть выполнена в электронном виде, затем – распечатана на принтере, с одной стороны листа, на бумаге белого цвета формата А4 (210 х 297 мм). Шрифт: TimesNewRoman, размер шрифта 14, для формул — 16, для таблиц — 10, 12 или 14.

Формулы обязательно должны вписываться согласно данным рекомендациям с помощью редактора формул. Рисунки, качественно выполненные на белой бумаге любым способом, помещают в текст. Объем дипломной работы – 50-70 печатных листов, включая титульный лист.

Расстановка переносов – автоматическая:

Отступ первой строки – 1,5 см, выравнивание – по ширине:

 

 

 

 

 

5. ОФОРМЛЕНИЕ ПОЯСНИТЕЛЬНОЙ ЗАПИСКИ

 

5.1 Общие требования

Пояснительная записка к дипломному проекту (в дальнейшем «Документ») должна быть выполнена на компьютере и содержать (без приложений) от 40 до 100 страниц текста. Конкретный объем оговаривается в задании на работу.

Текст документа должен быть напечатан через полтора интервала на одной стороне стандартного листа белой односортной бумаги формата А4 размером 210х297 мм (допускается представлять иллюстрации, таблицы и компьютерные распечатки на листах формата А3). Страницы должны иметь поля: левое – 20 мм, верхнее – 20 мм, правое – 10 мм, нижнее – 20 мм. Документ не должен содержать помарок, карандашных исправлений, пятен, трещин и загибов. Дорисовка букв чернилами запрещается. Все страницы Документа, включая иллюстрации и приложения, нумеруются по порядку от первой до последней страницы без пропусков. Первой страницей считается титульный лист, на котором цифра с номером страницы не ставится. Порядковый номер печатается в правом нижнем углу страницы. Небрежно оформленные Документы и Документы, содержащие ошибки, к защите не принимаются.

Текст Документа набирается шрифтом TimesNewRoman размером 12-14 пунктов, с автоматической расстановкой переносов, с выравниванием по ширине (в заголовках переносы слов не допускаются). Обратите внимание на некоторые моменты, связанные с разделителями и знаками препинания: не ставится пробел после открывающих скобок и кавычек, так же как не ставится пробел и перед закрывающими скобками и пробелами; также не ставится пробел перед запятой и ставится после.

Обратите внимание на изображение кавычек: всюду в русском тексте (включая список литературы) необходимо придерживаться только такой их формы «….», а не “…”! (В английском тексте используются кавычки вида "…").

Отступ красной строки в любом абзаце составляет 1,25 сантиметра. Никаких интервалов ни после, ни до абзацев не устанавливается.

Сокращения в тексте не допускаются, исключения составляют общепринятые сокращения и сокращения, для которых в тексте была приведена полная расшифровка.

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

Для величин, имеющих два предела, единица измерения пишется только один раз при второй цифре. Математические знаки, такие как «+», «–», «=», «>», «<» и так далее используются только в формулах. В тексте их следует писать словами: «плюс», «минус», «равно», «больше», «меньше». Например:

«Коэффициент стабильности на предприятиях индивидуального производства равен 0,6», «Периодичность обновления массива меньше периодичности решения задачи».

Перед переплетом и последующим предъявлением Документа на кафедру нужно проверить:

· идентичность заголовков в содержании и в работе, а также их общую редакционную согласованность;

· правильность подкладки листов (их последовательность, размещение относительно корешка);

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

· наличие подписей на заполненных титульном листе и бланке задания;

· наличие карандашных пометок или элементов оформления в карандаше;

· наличие сквозной нумерации страниц и соответствие ей содержания.

 

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

Текст Документа разбивается на разделы, которые нумеруются арабскими цифрами, начиная с 1, после цифры ставятся точка, пробел и собственно заголовок раздела с Заглавной буквы (остальные: в заголовке первого уровня – прописные, а в заголовках других уровней – строчные). После названия заголовка точка или какие-либо иные знаки не ставятся. Если заголовок включает несколько предложений, их разделяют точками. Заголовки разделов всех уровней оформляются с помощью набора стилей MS Word.

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

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

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

 

 

Оформление списков

Маркированный список. Наиболее предпочтительным видом списков является маркированный список с маркировкой кружочком: «·». Знак маркировки должен находиться в положении начала красной строки. Пример оформления такого списка:

Роль иерархического механизма управления выполняет интеллектуальный монитор, который:

· управляет функционированием системы;

· определяет, когда и какие задачи должны быть выполнены;

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

· реализует взаимодействие между компонентами системы, операторами и источниками данных.

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

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

Роль иерархического механизма управления выполняет интеллектуальный монитор, который:

1. управляет функционированием системы;

2. определяет, когда и какие задачи должны быть выполнены;

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

4. реализует взаимодействие между компонентами системы, операторами и источниками данных.