Урок 54, клас 9

9 клас

computer science

«Навчальна книга — Богдан»

УРОК 54

Документація. Коментарі, структурування коду

Що таке документація

Документація програми — це опис того, що робить програма, як вона працює і як її можна використовувати.

Для чого потрібна документація

- Іншим програмістам — щоб швидко зрозуміти, як працює код.

- Самому собі — щоб не забути логіку через певний час.

- Самому собі — щоб не забути логіку через певний час.

- Користувачу — щоб знати, як користуватися програмою.

Коментарі у програмі

Коментар — це рядок у програмі, який не виконується, а лише пояснює роботу коду.

Як їх записують у Python:

Види коментарів:

Однорядкові коментарі — починаються з #

Багаторядкові коментарі

Документування функцій

Коли ми створюємо функції, варто пояснювати, що вони роблять.Для цього в Python є спеціальний коментар — docstring (документуючий рядок).

Приклад:

Якщо викликати help(add_numbers), Python навіть покаже цей опис у вікні довідки!

Структурування коду

Добре структурований код:

не плутає того, хто його перевіряє

зручно змінювати

легко читати

Основні правила структурування

2. Залишай порожні рядки між частинами програми для кращої читабельності.

1. Розділяй код на логічні блоки

4. Використовуй коментарі над важливими частинами коду, щоб пояснити логіку.

3. Надавай змінним змістовні назви

❌ x = 100✅ speed_kmh = 100

Документація проєкту

Коли ви створюєте великий проєкт, важливо мати файл із описом програми (наприклад, readme.txt або readme.md).

У ньому можна зазначити:

Приклади з життя

- Назву проєкту - Авторів - Мету програми - Які модулі використовуються - Як запустити програму - Приклади використання

Приклад повної програми з документацією

Дякую за увагу!