2.7 KiB
Komentirajte svojo kodo
Navodila
Čista, dobro dokumentirana koda je ključna za vzdrževanje in deljenje vaših projektov. V tej nalogi boste vadili eno najpomembnejših navad profesionalnih razvijalcev: pisanje jasnih, koristnih komentarjev, ki pojasnjujejo namen in funkcionalnost vaše kode.
Preglejte svojo trenutno datoteko app.js v mapi igre in poiščite načine, kako jo komentirati in urediti. Koda se lahko zelo hitro zaplete, zato je zdaj dobra priložnost, da dodate komentarje in zagotovite, da je vaša koda berljiva, da jo boste lahko uporabili kasneje.
Vaša naloga vključuje:
- Dodajte komentarje, ki pojasnjujejo, kaj počne vsak večji del kode
- Dokumentirajte funkcije z jasnimi opisi njihovega namena in parametrov
- Organizirajte kodo v logične bloke z naslovi odsekov
- Odstranite morebitno neuporabljeno ali odvečno kodo
- Uporabljajte dosledne poimenovalne konvencije za spremenljivke in funkcije
Merila ocenjevanja
| Merilo | Odlično | Zadostno | Potrebno izboljšanje |
|---|---|---|---|
| Dokumentacija kode | Koda v app.js je v celoti komentirana z jasnimi, koristnimi pojasnili za vse večje odseke in funkcije |
Koda v app.js je ustrezno komentirana z osnovnimi pojasnili za večino odsekov |
Koda v app.js ima minimalne komentarje in ji manjkajo jasna pojasnila |
| Organizacija kode | Koda je organizirana v logične bloke z jasnimi naslovi odsekov in dosledno strukturo | Koda je delno organizirana z osnovnim združevanjem povezanih funkcionalnosti | Koda je nekoliko neorganizirana in težko sledljiva |
| Kakovost kode | Vse spremenljivke in funkcije uporabljajo opisna imena, ni neuporabljene kode, sledi doslednim konvencijam | Večina kode sledi dobrim praksam poimenovanja z minimalno neuporabljeno kodo | Imena spremenljivk so nejasna, vsebuje neuporabljeno kodo, nedosleden slog |
Omejitev odgovornosti:
Ta dokument je bil preveden z uporabo storitve za prevajanje AI Co-op Translator. Čeprav si prizadevamo za natančnost, vas prosimo, da upoštevate, da lahko avtomatizirani prevodi vsebujejo napake ali netočnosti. Izvirni dokument v njegovem maternem jeziku naj se šteje za avtoritativni vir. Za ključne informacije priporočamo profesionalni človeški prevod. Ne odgovarjamo za morebitna nesporazumevanja ali napačne razlage, ki izhajajo iz uporabe tega prevoda.