Рекомендации по оформлению программного кода

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

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

В Windows стиле первая часть пишется с маленькой буквы, каждая последующая с большой. Например, taskState, showTbl.

В Unix стиле составные части разделяются знаком «_». Например, task_state, show_tbl.

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

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

 

ПрограммнОЕ СРЕДСТВО

 

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

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

 

ДИСК

 

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

1) программное обеспечение внедрено в эксплуатацию и приведены данные акта внедрения,

2) программный код является коммерческой тайной организации.

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

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

- исходный программный код;

- sql-код для развертывания БД (в случае использование БД);

- дополнительные компоненты, библиотеки, модули, фрэймворки;

- разработанные образцы шаблонов дизайна, схемы, информационное наполнение и т.д.;

- работающий exe-файл или исполнимый файл (в случае если его можно создать);

- файл под названием readme.txt, в котором поясняется назначение каждого из содержащихся в папке файлов и подкаталогов.

На диске должна присутствовать одна последняя версия каждого из файлов.

 

Презентация

 

Выступление дипломника во время защиты ДП должно сопровождаться презентацией.

На слайдах презентации должна быть отражена информация:

- сведения о дипломном проекте (тема, дипломник, руководитель, год);

- предметная область;

- функциональные возможности (можно UML-диаграмма);

- средства и технологии разработки;

- схема БД либо хранения данных;

- структура программного кода, разработанного дипломником самостоятельно (можно UML-диаграмма);

- сетевые архитектуры (схема);

- выводы и проделанной работе.

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

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