2.8 KiB
Komentujte svůj kód
Pokyny
Čistý, dobře zdokumentovaný kód je nezbytný pro udržování a sdílení vašich projektů. V tomto úkolu si procvičíte jeden z nejdůležitějších návyků profesionálních vývojářů: psaní jasných, užitečných komentářů, které vysvětlují účel a funkčnost vašeho kódu.
Projděte si svůj aktuální soubor app.js ve složce hry a najděte způsoby, jak jej okomentovat a upravit. Je velmi snadné, aby se kód stal nepřehledným, a nyní máte dobrou příležitost přidat komentáře, abyste zajistili, že váš kód bude čitelný a použitelný i později.
Vaše úkoly zahrnují:
- Přidat komentáře, které vysvětlují, co dělá každá hlavní část kódu
- Zdokumentovat funkce jasnými popisy jejich účelu a parametrů
- Organizovat kód do logických bloků s nadpisy sekcí
- Odstranit jakýkoli nepoužívaný nebo redundantní kód
- Používat konzistentní pojmenování proměnných a funkcí
Hodnotící kritéria
| Kritéria | Vynikající | Dostatečné | Vyžaduje zlepšení |
|---|---|---|---|
| Dokumentace kódu | Kód v app.js je plně okomentován s jasnými, užitečnými vysvětleními všech hlavních částí a funkcí |
Kód v app.js je dostatečně okomentován se základními vysvětleními většiny částí |
Kód v app.js má minimální komentáře a postrádá jasná vysvětlení |
| Organizace kódu | Kód je organizován do logických bloků s jasnými nadpisy sekcí a konzistentní strukturou | Kód má určitou organizaci se základním seskupením souvisejících funkcí | Kód je poněkud neorganizovaný a obtížně sledovatelný |
| Kvalita kódu | Všechny proměnné a funkce mají popisné názvy, žádný nepoužívaný kód, dodržuje konzistentní konvence | Většina kódu dodržuje dobré pojmenovací praktiky s minimem nepoužívaného kódu | Názvy proměnných jsou nejasné, obsahuje nepoužívaný kód, nekonzistentní styl |
Prohlášení:
Tento dokument byl přeložen pomocí služby AI pro překlad Co-op Translator. Ačkoli se snažíme o přesnost, mějte na paměti, že automatizované překlady mohou obsahovat chyby nebo nepřesnosti. Původní dokument v jeho původním jazyce by měl být považován za autoritativní zdroj. Pro důležité informace se doporučuje profesionální lidský překlad. Neodpovídáme za žádná nedorozumění nebo nesprávné interpretace vyplývající z použití tohoto překladu.