4.6 KiB
Коментирайте вашия код
Инструкции
Чистият и добре документиран код е от съществено значение за поддържането и споделянето на вашите проекти. В това задание ще практикувате един от най-важните навици на професионалните разработчици: писане на ясни и полезни коментари, които обясняват целта и функционалността на вашия код.
Прегледайте текущия си файл app.js в папката на играта и намерете начини да го коментирате и подредите. Много лесно е кодът да излезе извън контрол, а сега е добър момент да добавите коментари, за да сте сигурни, че имате четим код, който можете да използвате по-късно.
Вашата задача включва:
- Добавете коментари, които обясняват какво прави всяка основна секция от кода
- Документирайте функциите с ясни описания на тяхната цел и параметри
- Организирайте кода в логически блокове с заглавия на секции
- Премахнете всякакъв неизползван или излишен код
- Използвайте последователни конвенции за именуване на променливи и функции
Рубрика
| Критерии | Отлично | Задоволително | Нуждае се от подобрение |
|---|---|---|---|
| Документация на кода | Кодът в app.js е напълно коментиран с ясни и полезни обяснения за всички основни секции и функции |
Кодът в app.js е адекватно коментиран с основни обяснения за повечето секции |
Кодът в app.js има минимални коментари и липсват ясни обяснения |
| Организация на кода | Кодът е организиран в логически блокове с ясни заглавия на секции и последователна структура | Кодът има известна организация с основно групиране на свързана функционалност | Кодът е донякъде неорганизиран и труден за следване |
| Качество на кода | Всички променливи и функции използват описателни имена, няма неизползван код, следва последователни конвенции | Повечето код следва добри практики за именуване с минимален неизползван код | Имената на променливите са неясни, съдържа неизползван код, непоследователен стил |
Отказ от отговорност:
Този документ е преведен с помощта на AI услуга за превод Co-op Translator. Въпреки че се стремим към точност, моля, имайте предвид, че автоматизираните преводи може да съдържат грешки или неточности. Оригиналният документ на неговия роден език трябва да се счита за авторитетен източник. За критична информация се препоръчва професионален човешки превод. Ние не носим отговорност за каквито и да е недоразумения или погрешни интерпретации, произтичащи от използването на този превод.