2.7 KiB
Kommenter koden din
Instruksjoner
Ren, godt dokumentert kode er essensielt for å vedlikeholde og dele prosjektene dine. I denne oppgaven skal du øve på en av de viktigste vanene til profesjonelle utviklere: å skrive klare, hjelpsomme kommentarer som forklarer formålet og funksjonaliteten til koden din.
Gå gjennom din nåværende app.js-fil i spillmappen din, og finn måter å kommentere og rydde opp i den. Det er veldig lett for kode å bli uoversiktlig, og nå har du en god mulighet til å legge til kommentarer for å sikre at koden din er lesbar og kan brukes senere.
Oppgaven din inkluderer:
- Legg til kommentarer som forklarer hva hver hoveddel av koden gjør
- Dokumenter funksjoner med klare beskrivelser av deres formål og parametere
- Organiser koden i logiske blokker med seksjonsoverskrifter
- Fjern all ubrukt eller overflødig kode
- Bruk konsekvente navnekonvensjoner for variabler og funksjoner
Vurderingskriterier
| Kriterier | Eksemplarisk | Tilfredsstillende | Trenger forbedring |
|---|---|---|---|
| Kodekommentarer | app.js-koden er fullstendig kommentert med klare, hjelpsomme forklaringer for alle hoveddeler og funksjoner |
app.js-koden er tilstrekkelig kommentert med grunnleggende forklaringer for de fleste deler |
app.js-koden har minimale kommentarer og mangler klare forklaringer |
| Kodeorganisering | Koden er organisert i logiske blokker med klare seksjonsoverskrifter og konsekvent struktur | Koden har noe organisering med grunnleggende gruppering av relatert funksjonalitet | Koden er noe uorganisert og vanskelig å følge |
| Kodekvalitet | Alle variabler og funksjoner bruker beskrivende navn, ingen ubrukt kode, følger konsekvente konvensjoner | Mesteparten av koden følger gode navnepraksiser med minimal ubrukt kode | Variabelnavn er uklare, inneholder ubrukt kode, inkonsekvent stil |
Ansvarsfraskrivelse:
Dette dokumentet er oversatt ved hjelp av AI-oversettelsestjenesten Co-op Translator. Selv om vi tilstreber nøyaktighet, vær oppmerksom på at automatiserte oversettelser kan inneholde feil eller unøyaktigheter. Det originale dokumentet på dets opprinnelige språk bør anses som den autoritative kilden. For kritisk informasjon anbefales profesjonell menneskelig oversettelse. Vi er ikke ansvarlige for eventuelle misforståelser eller feiltolkninger som oppstår ved bruk av denne oversettelsen.