2.9 KiB
Komentujte svoj kód
Pokyny
Čistý, dobre zdokumentovaný kód je nevyhnutný pre udržiavanie a zdieľanie vašich projektov. V tejto úlohe si precvičíte jeden z najdôležitejších návykov profesionálnych vývojárov: písanie jasných, užitočných komentárov, ktoré vysvetľujú účel a funkčnosť vášho kódu.
Prejdite si svoj aktuálny súbor app.js vo vašom priečinku hry a nájdite spôsoby, ako ho okomentovať a upraviť. Je veľmi jednoduché, aby sa kód stal neprehľadným, a teraz máte dobrú príležitosť pridať komentáre, aby ste zabezpečili, že váš kód bude čitateľný a použiteľný aj neskôr.
Vaša úloha zahŕňa:
- Pridať komentáre, ktoré vysvetľujú, čo robí každá hlavná časť kódu
- Zdokumentovať funkcie jasnými popismi ich účelu a parametrov
- Organizovať kód do logických blokov s nadpismi sekcií
- Odstrániť akýkoľvek nepoužitý alebo redundantný kód
- Používať konzistentné názvy premenných a funkcií
Hodnotiace kritériá
| Kritérium | Vynikajúce | Dostatočné | Potrebuje zlepšenie |
|---|---|---|---|
| Dokumentácia kódu | Kód v app.js je plne okomentovaný s jasnými, užitočnými vysvetleniami všetkých hlavných sekcií a funkcií |
Kód v app.js je dostatočne okomentovaný so základnými vysvetleniami väčšiny sekcií |
Kód v app.js má minimálne komentáre a chýbajú jasné vysvetlenia |
| Organizácia kódu | Kód je organizovaný do logických blokov s jasnými nadpismi sekcií a konzistentnou štruktúrou | Kód má určitú organizáciu so základným zoskupením súvisiacej funkcionality | Kód je čiastočne neorganizovaný a ťažko sledovateľný |
| Kvalita kódu | Všetky premenné a funkcie majú popisné názvy, žiadny nepoužitý kód, dodržiava konzistentné konvencie | Väčšina kódu dodržiava dobré názvoslovné praktiky s minimálnym nepoužitým kódom | Názvy premenných sú nejasné, obsahuje nepoužitý kód, nekonzistentný štýl |
Zrieknutie sa zodpovednosti:
Tento dokument bol preložený pomocou služby AI prekladu Co-op Translator. Aj keď sa snažíme o presnosť, prosím, berte na vedomie, že automatizované preklady môžu obsahovať chyby alebo nepresnosti. Pôvodný dokument v jeho rodnom jazyku by mal byť považovaný za autoritatívny zdroj. Pre kritické informácie sa odporúča profesionálny ľudský preklad. Nenesieme zodpovednosť za akékoľvek nedorozumenia alebo nesprávne interpretácie vyplývajúce z použitia tohto prekladu.