2.6 KiB
Komentuokite savo kodą
Instrukcijos
Tvarkingas, gerai dokumentuotas kodas yra labai svarbus palaikant ir dalijantis projektais. Šiame pratybų uždavinyje praktikuositės vieną svarbiausių profesionalių programuotojų įpročių: rašyti aiškius, naudingus komentarus, kurie paaiškina jūsų kodo paskirtį ir funkcionalumą.
Peržiūrėkite esamą savo žaidimo kataloge esantį failą app.js ir raskite būdų jį pakomentuoti bei sutvarkyti. Labai lengva, kad kodas ims plėstis be tvarkos, todėl dabar yra gera proga pridėti komentarų, kad turėtumėte skaitomą kodą, kurį galėtumėte naudoti ateityje.
Jūsų užduotis apima:
- Pridėti komentarus, aiškinančius, ką atlieka kiekviena pagrindinė kodo dalis
- Dokumentuoti funkcijas aiškiais aprašymais apie jų paskirtį ir parametrus
- Organizuoti kodą į logiškus blokus su skyrių antraštėmis
- Pašalinti bet kokį nenaudojamą arba perteklinį kodą
- Naudoti nuoseklias kintamųjų ir funkcijų vardų rašybos taisykles
Vertinimo kriterijai
| Kriterijus | Puikiai | Patenkinamai | Reikia tobulinti |
|---|---|---|---|
| Kodo dokumentacija | app.js failas pilnai pakomentuotas su aiškiais, naudingais paaiškinimais visoms pagrindinėms dalims ir funkcijoms |
app.js failas pakankamai pakomentuotas su pagrindiniais paaiškinimais daugumai dalių |
app.js failas turi minimaliai komentarų ir trūksta aiškių paaiškinimų |
| Kodo organizavimas | Kodas organizuotas į logiškus blokus su aiškiomis skyrių antraštėmis ir nuoseklia struktūra | Kodas yra tam tikru mastu organizuotas su pagrindiniu sugrupavimu pagal funkcionalumą | Kodas yra ganėtinai nesutvarkytas ir sunkiai suprantamas |
| Kodo kokybė | Visi kintamieji ir funkcijos turi aprašomuosius vardus, nėra nenaudojamo kodo, laikomasi nuoseklių taisyklių | Dauguma kodo naudoja gerus vardus su minimaliu nenaudojamo kodo kiekiu | Kintamųjų vardai neaiškūs, yra nenaudojamo kodo, nesilaikoma stiliaus |
Atsakomybės apribojimas: Šis dokumentas buvo išverstas naudojant dirbtinio intelekto vertimo paslaugą Co-op Translator. Nors siekiame tikslumo, prašome atkreipti dėmesį, kad automatiniai vertimai gali turėti klaidų ar netikslumų. Pirminis dokumentas jo gimtąja kalba yra laikomas autoritetingu šaltiniu. Svarbiai informacijai rekomenduojamas profesionalus žmogaus vertimas. Mes neatsakome už bet kokius nesusipratimus ar neteisingus aiškinimus, atsiradusius dėl šio vertimo naudojimo.