4.5 KiB
Коментуйте свій код
Інструкції
Чистий, добре документований код є важливим для підтримки та обміну вашими проєктами. У цьому завданні ви будете практикувати одну з найважливіших звичок професійних розробників: написання зрозумілих, корисних коментарів, які пояснюють призначення та функціональність вашого коду.
Перегляньте ваш поточний файл app.js у папці вашої гри та знайдіть способи додати коментарі та впорядкувати його. Код дуже легко може стати хаотичним, і зараз гарна нагода додати коментарі, щоб забезпечити його читабельність для подальшого використання.
Ваше завдання включає:
- Додати коментарі, які пояснюють, що робить кожен основний розділ коду
- Документувати функції з чіткими описами їх призначення та параметрів
- Організувати код у логічні блоки з заголовками розділів
- Видалити будь-який невикористаний або зайвий код
- Використовувати послідовні правила іменування для змінних та функцій
Рубрика
| Критерії | Відмінно | Достатньо | Потребує покращення |
|---|---|---|---|
| Документування коду | Код app.js повністю прокоментований з чіткими, корисними поясненнями для всіх основних розділів та функцій |
Код app.js адекватно прокоментований з базовими поясненнями для більшості розділів |
Код app.js має мінімум коментарів і не містить чітких пояснень |
| Організація коду | Код організований у логічні блоки з чіткими заголовками розділів та послідовною структурою | Код має деяку організацію з базовим групуванням пов'язаних функцій | Код дещо неорганізований і важкий для розуміння |
| Якість коду | Усі змінні та функції мають описові назви, немає невикористаного коду, дотримуються послідовні правила | Більшість коду дотримується хороших практик іменування з мінімумом невикористаного коду | Назви змінних незрозумілі, містить невикористаний код, стиль непослідовний |
Відмова від відповідальності:
Цей документ був перекладений за допомогою сервісу автоматичного перекладу Co-op Translator. Хоча ми прагнемо до точності, будь ласка, майте на увазі, що автоматичні переклади можуть містити помилки або неточності. Оригінальний документ на його рідній мові слід вважати авторитетним джерелом. Для критичної інформації рекомендується професійний людський переклад. Ми не несемо відповідальності за будь-які непорозуміння або неправильні тлумачення, що виникають внаслідок використання цього перекладу.