2.9 KiB
Kommentoi koodiasi
Ohjeet
Selkeästi dokumentoitu koodi on välttämätöntä projektien ylläpidossa ja jakamisessa. Tässä tehtävässä harjoittelet yhtä ammattikehittäjien tärkeimmistä tavoista: kirjoittamaan selkeitä ja hyödyllisiä kommentteja, jotka selittävät koodisi tarkoituksen ja toiminnallisuuden.
Käy läpi nykyinen app.js-tiedostosi pelin kansiossa ja etsi tapoja kommentoida ja siistiä sitä. Koodi voi helposti muuttua sekavaksi, ja nyt on hyvä tilaisuus lisätä kommentteja varmistaaksesi, että koodisi on luettavaa ja käyttökelpoista myöhemmin.
Tehtäväsi sisältää:
- Lisää kommentteja, jotka selittävät, mitä kukin koodin pääosa tekee
- Dokumentoi funktiot selkeillä kuvauksilla niiden tarkoituksesta ja parametreista
- Järjestä koodi loogisiin osiin otsikoiden avulla
- Poista kaikki käyttämätön tai tarpeeton koodi
- Käytä johdonmukaisia nimeämiskäytäntöjä muuttujille ja funktioille
Arviointikriteerit
| Kriteeri | Erinomainen | Riittävä | Parannusta tarvitaan |
|---|---|---|---|
| Koodin dokumentointi | app.js-koodi on täysin kommentoitu selkeillä ja hyödyllisillä selityksillä kaikille pääosille ja funktioille |
app.js-koodi on riittävästi kommentoitu perusselityksillä useimmille osille |
app.js-koodissa on vähän kommentteja ja selitykset ovat epäselviä |
| Koodin organisointi | Koodi on järjestetty loogisiin osiin selkeillä otsikoilla ja johdonmukaisella rakenteella | Koodi on osittain järjestetty, ja siinä on perusryhmittelyä liittyvälle toiminnallisuudelle | Koodi on jonkin verran epäjärjestyksessä ja vaikeasti seurattavaa |
| Koodin laatu | Kaikki muuttujat ja funktiot käyttävät kuvailevia nimiä, ei käyttämätöntä koodia, noudattaa johdonmukaisia käytäntöjä | Suurin osa koodista noudattaa hyviä nimeämiskäytäntöjä ja sisältää vain vähän käyttämätöntä koodia | Muuttujien nimet ovat epäselviä, sisältää käyttämätöntä koodia, epäjohdonmukainen tyyli |
Vastuuvapauslauseke:
Tämä asiakirja on käännetty käyttämällä tekoälypohjaista käännöspalvelua Co-op Translator. Vaikka pyrimme tarkkuuteen, huomioithan, että automaattiset käännökset voivat sisältää virheitä tai epätarkkuuksia. Alkuperäinen asiakirja sen alkuperäisellä kielellä tulisi pitää ensisijaisena lähteenä. Kriittisen tiedon osalta suositellaan ammattimaista ihmiskäännöstä. Emme ole vastuussa väärinkäsityksistä tai virhetulkinnoista, jotka johtuvat tämän käännöksen käytöstä.