|
|
<!--
|
|
|
CO_OP_TRANSLATOR_METADATA:
|
|
|
{
|
|
|
"original_hash": "c162b3b3a1cafc1483c8015e9b266f0d",
|
|
|
"translation_date": "2025-10-22T22:28:09+00:00",
|
|
|
"source_file": "6-space-game/3-moving-elements-around/assignment.md",
|
|
|
"language_code": "ru"
|
|
|
}
|
|
|
-->
|
|
|
# Комментируйте ваш код
|
|
|
|
|
|
## Инструкции
|
|
|
|
|
|
Чистый, хорошо документированный код необходим для поддержания и обмена вашими проектами. В этом задании вы будете практиковать один из самых важных навыков профессиональных разработчиков: написание понятных и полезных комментариев, объясняющих назначение и функциональность вашего кода.
|
|
|
|
|
|
Просмотрите ваш текущий файл `app.js` в папке с игрой и найдите способы прокомментировать его и привести в порядок. Код очень легко может выйти из-под контроля, и сейчас хороший момент, чтобы добавить комментарии, чтобы убедиться, что ваш код читаем и вы сможете использовать его позже.
|
|
|
|
|
|
**Ваши задачи включают:**
|
|
|
- **Добавить комментарии**, объясняющие, что делает каждая основная часть кода
|
|
|
- **Документировать функции** с четкими описаниями их назначения и параметров
|
|
|
- **Организовать код** в логические блоки с заголовками разделов
|
|
|
- **Удалить** любой неиспользуемый или избыточный код
|
|
|
- **Использовать единообразные** соглашения о наименовании переменных и функций
|
|
|
|
|
|
## Критерии оценки
|
|
|
|
|
|
| Критерий | Превосходно | Удовлетворительно | Требует улучшения |
|
|
|
| -------- | ----------- | ----------------- | ----------------- |
|
|
|
| **Документирование кода** | Код в `app.js` полностью прокомментирован с четкими, полезными объяснениями для всех основных разделов и функций | Код в `app.js` адекватно прокомментирован с базовыми объяснениями для большинства разделов | Код в `app.js` содержит минимальное количество комментариев и не имеет четких объяснений |
|
|
|
| **Организация кода** | Код организован в логические блоки с четкими заголовками разделов и последовательной структурой | Код имеет некоторую организацию с базовым группированием связанной функциональности | Код несколько неорганизован и труден для понимания |
|
|
|
| **Качество кода** | Все переменные и функции имеют описательные названия, отсутствует неиспользуемый код, соблюдаются единообразные соглашения | Большая часть кода следует хорошим практикам наименования с минимальным количеством неиспользуемого кода | Названия переменных неясны, присутствует неиспользуемый код, стиль непоследователен |
|
|
|
|
|
|
---
|
|
|
|
|
|
**Отказ от ответственности**:
|
|
|
Этот документ был переведен с использованием сервиса автоматического перевода [Co-op Translator](https://github.com/Azure/co-op-translator). Несмотря на наши усилия обеспечить точность, автоматические переводы могут содержать ошибки или неточности. Оригинальный документ на его родном языке следует считать авторитетным источником. Для получения критически важной информации рекомендуется профессиональный перевод человеком. Мы не несем ответственности за любые недоразумения или неправильные интерпретации, возникающие в результате использования данного перевода. |
