Рекомендації з оформлення програмного коду

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

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

У Windows стилі перша частина пишеться з маленької літери, кожна наступна з великою. Наприклад, taskState, showTbl.

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

Програмний код полягає в рамку. Приклад оформлення програмного коду наведено в додатку Ж.

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

В ДЕК видається диск, на якому міститься пояснювальна записка, презентація і програмний продукт і засоби необхідні для його роботи. Програмний продукт може не надаватися в ДЕК в разі, коли додається довідка з організації-замовника, в якій зазначено два факти що:

1) програмне забезпечення впроваджено в експлуатацію і наведені дані акта впровадження,

2) програмний код є комерційною таємницею організації.

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

Матеріали по програмному продукту поміщаються в папку, назва якої відповідає прізвища студента. В папці можуть міститися:

- вихідний програмний код;

- sql-код для розгортання БД (в разі використання БД);

- додаткові компоненти, бібліотеки, модулі, фреймворкі;

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

- працюючий exe-файл або виконуваний файл (в разі якщо його можна створити);

- файл під назвою readme.txt, в якому пояснюється призначення кожного з містяться в папці файлів і підкаталогів.

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

Виступ дипломника під час захисту ДП повинно супроводжуватися презентацією.

На слайдах презентації повинна бути відображена інформація:

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

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

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

- схема БД або зберігання даних;

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

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

- висновки і виконану роботу.

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

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