Правила оформления отчётов
Содержание отчёта
На первой странице отчёта располагается титульный лист. На второй странице располагается содержание. За ним идёт задание. После задания следует исследуемая схема. Над схемой приводится её краткое описание со ссылкой на рисунок.
Следующим пунктом идёт блок-схема реализуемого алгоритма. После неё идет словесное описание алгоритма, представленного на блок схеме и обоснование этого варианта реализации. Процесс повторяется для каждой из реализованных блок схем.
В конце делаются выводы по работе с анализом проведённой работы и оценкой полученных результатов.
В приложение выносятся все программные коды.
Оформление титульного листа
Оформление титульного листа приведено в приложении 1.
Общие настройки оформления отчёта
Печать односторонняя.
Формат листа: А4.
Размер шрифта: 14.
Интервал: 1.5.
Поля: 20 мм.
Отступ красной строки. 10 мм
Выравнивание текста по ширине за исключением специально оговорённых случаев, например, подписей под рисунками.
При рукописном оформлении необходимо выдерживать требования по размеру полей.
Оформление рисунков
На каждый рисунок должна быть ссылка в тексте, например "... приведено на рис. 2.3" или "... составим схему замещения (рис. 2.5)". При повторной ссылке на одну и ту же иллюстрацию указывают сокращенно слово "смотри", например: (см. рис. 2.3).
Рисунки могут быть расположены по тексту документа после первой ссылки на них или размещены на отдельных листах так, чтобы их было удобно рассматривать без поворота страницы или с поворотом по часовой стрелке. В этом случае рисунок не прикрепляется к отчёту, а просто вкладывается.
Рисунок выравнивается по центру. Крайне желательно, что бы рисунок и ссылка на него располагались на одной странице, если рисунок не выносится в приложение.
Рисунок без ссылок в тексте использоваться не может.
Оформление таблиц
Таблицу размещают после первого упоминания в тексте так, чтобы ее было удобно читать без поворота отчёта или с поворотом по часовой стрелке.
На все таблицы должны быть ссылки в тексте, например "... приведены в табл.1.2". Если таблица не имеет номера, при ссылке слово "таблица" пишут полностью.
Если все физические величины, приведенные в таблице, выражены в одних и тех же единицах, то обозначение единицы помещают в заголовке через запятую, например: "Размеры изделий, мм".
Обозначение единицы физической величины, общей для всех данных в строке или графе, указывают в соответствующей строке боковика или в заголовке графы.
Не допускается делить заголовки таблицы по диагонали и включать графу "номер по порядку".
Нумерация
Нумерация рисунков
Нумерация рисунков в лабораторном отчёте сквозная. Рисунок подписывается снизу по центру. Например: Рис. 1. Тестовое изображение “Lena”. После названия рисунка точка не ставится. Подпись под рисунком и сам рисунок должны располагаться на одной странице. Все рисунки должны быть подписаны.
Рис. 1. Тестовое изображение “Lena”
Нумерация таблиц
Нумерация таблиц, так же как и рисунков в лабораторном отчёте сквозная. Все таблицы должны быть пронумерованы. Подписывается таблица справа сверху. Например:
| Таблица 1. | |||
Если в отчете одна таблица, те её не нумеруют (пишут “Таблица”). При переносе таблицы на другой лист в его правом верхнем углу пишут слово "продолжение" и номер таблицы, например, "Продолжение табл. 1.2". Если в отчете одна таблица, то при ее переносе пишут слово "Продолжение"
Нумерация страниц
Титульный лист считается первой страницей и не нумеруется. Нумерация начинается со второй страницы, делается арабскими цифрами и выравнивается по центру внизу страницы.
Нумерация списков
Содержащиеся в тексте перечисления выделяют арабскими цифрами со скобкой: 1), 2) и т.д., или вместо цифр ставят тире.
Нумерация приложений
Приложения имеют отдельную от общего текста нумерацию.
Оформление программного кода
Табуляция
Табуляция или смещение кода направо делается по следующим правилам.
Код, содержащийся внутри фигурных скобок, смещается направо на 1.
{
<code>;
}
В частности:
Весь код внутри функции должен быть смещён на 1.
Код внутри циклов и операторов if так же должен иметь смещение 1, прибавляемое к уже имеющемуся смещению самого оператора.
void function1(void)
{
<code1>;
if (<условие>)
{
<code2>;
}
}
Пустые строки
Пустые строки должны отделать одну часть кода от другой. В частности.
Должна быть минимум одна пустая строка после всего перечня #include.
Должна быть минимум одна пустая строка после всего перечня #define.
Между функциями должно быть не менее 2-х строк.
Должна быть хотя бы одна пустая строка после объявления всех переменных.
Разделение кода на функции
Крайне желательно разделять код на исполняемые участки (функции). В частности инициализация микроконтроллера должна быть вынесена в отдельные функции. Например: void MCU_ini(void) {} или void LED_ini(void){}. В функции main используются только сами функции.
Использование директивы #define
Часто используемые константы или блоки кода должны быть заменены на ключевые выражения при помощи директивы #define.
#define PI 3.14
#define LED_ON() GPIO_Set(GPIOB, GPIO_Pin_6)
#define LED_OFF() GPIO_Reset(GPIOB, GPIO_Pin_6)
Ключевые выражения традиционно записываются с использованием только заглавных букв.
Комментарии
Как минимум каждый блок кода должен иметь комментарий с описанием того, что он делает. Функции должны сверху иметь как минимум комментарий //---------------------------------------, позволяющий легко вычислять местоположение начала функции. Данный комментарий используется, если применение функции очевидно (говорящее название, не имеет параметров и т.д.).
Если необходимо подробно описать функцию, используется комментарий вида:
//---------------------------------------
// Описание функции
//---------------------------------------
Где во второй строке пишется описание того, что делает эта функция. При необходимости приводится описание входных и выходных параметров.
Правила именования переменных.
Глобальные переменные должны иметь говорящие об их назначении названия (uart_transmit_data[], uart_receive_data[]). Локальные переменные могут иметь короткие, безликие названия в том случае, если их использование ограничивается короткой функцией (счетчик цикла).
В качестве названий локальных переменных как правило используют следующие:
Для циклов зачастую используют переменные I, j, k. Например:
for (i=0;i<N;i++) {}
Для строковых переменных используют название str.
Приложение
