2.9 KiB
Kommentáld a kódodat
Útmutató
A tiszta, jól dokumentált kód elengedhetetlen a projektek karbantartásához és megosztásához. Ebben a feladatban gyakorolhatod a profi fejlesztők egyik legfontosabb szokását: világos, hasznos kommentek írását, amelyek elmagyarázzák a kód célját és működését.
Nézd át a játék mappádban található app.js fájlt, és keress lehetőségeket arra, hogy kommenteket adj hozzá, valamint rendezd át. Nagyon könnyű, hogy a kód kaotikussá váljon, és most jó alkalom arra, hogy kommenteket adj hozzá, hogy később is érthető legyen.
A feladatod:
- Adj hozzá kommenteket, amelyek elmagyarázzák, mit csinál a kód minden főbb része
- Dokumentáld a függvényeket világos leírással a céljukról és paramétereikről
- Szervezd a kódot logikus blokkokba szekciófejlécekkel
- Távolítsd el a nem használt vagy redundáns kódot
- Használj következetes elnevezési konvenciókat a változók és függvények esetében
Értékelési szempontok
| Kritérium | Kiváló | Megfelelő | Fejlesztésre szorul |
|---|---|---|---|
| Kód dokumentációja | Az app.js kód teljesen kommentált, világos, hasznos magyarázatokkal minden főbb részhez és függvényhez |
Az app.js kód megfelelően kommentált, alapvető magyarázatokkal a legtöbb részhez |
Az app.js kód minimális kommenteket tartalmaz, és hiányoznak a világos magyarázatok |
| Kód szervezése | A kód logikus blokkokba van szervezve, világos szekciófejlécekkel és következetes struktúrával | A kód részben szervezett, alapvető csoportosítással a kapcsolódó funkciókhoz | A kód kissé rendezetlen és nehezen követhető |
| Kód minősége | Minden változó és függvény leíró neveket használ, nincs nem használt kód, következetes konvenciókat követ | A legtöbb kód jó elnevezési gyakorlatokat követ, minimális nem használt kóddal | A változónevek nem egyértelműek, tartalmaz nem használt kódot, következetlen stílus |
Felelősség kizárása:
Ez a dokumentum az Co-op Translator AI fordítási szolgáltatás segítségével lett lefordítva. Bár törekszünk a pontosságra, kérjük, vegye figyelembe, hogy az automatikus fordítások hibákat vagy pontatlanságokat tartalmazhatnak. Az eredeti dokumentum az eredeti nyelvén tekintendő hiteles forrásnak. Kritikus információk esetén javasolt professzionális emberi fordítást igénybe venni. Nem vállalunk felelősséget semmilyen félreértésért vagy téves értelmezésért, amely a fordítás használatából eredhet.