msb-public
/
Web-Dev-For-Beginners
mirror of https://github.com/microsoft/Web-Dev-For-Beginners.git
1
0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'softchris-patch-33'
${ noResults }
Web-Dev-For-Beginners/translations/et/6-space-game/3-moving-elements-around/assignment.md

2.6 KiB
Raw Permalink Blame History

Kommenteeri oma koodi

Juhised

Puhtas ja hästi dokumenteeritud koodis on projekti hooldamine ja jagamine hädavajalik. Selles ülesandes harjutad ühte professionaalsete arendajate tähtsamatest harjumustest: kirjutada selged, abistavad kommentaarid, mis selgitavad su koodi eesmärki ja funktsionaalsust.

Vaata läbi oma mängu kaustas olev app.js fail ning leia viise, kuidas seda kommenteerida ja korrastada. Kood võib väga kergesti kontrolli alt väljuda ning nüüd on hea võimalus lisada kommentaare, et sul oleks loetav kood, mida hiljem kasutada.

Sinu ülesandeks on:

  • Lisa kommentaarid, mis selgitavad, mida iga peamine koodilõik teeb
  • Dokumenteeri funktsioonid selgete kirjeldustega nende eesmärgi ja parameetrite kohta
  • Korralda kood loogilistesse plokkidesse ja lisa sektsioonide päised
  • Eemalda kasutamata või üleliigne kood
  • Kasuta ühtseid muutujate ja funktsioonide nimetamise tavasid

Hinnangukriteeriumid

Kriteerium Näidiskvaliteet Piisav Vajab parandamist
Koodi dokumentatsioon app.js kood on täielikult kommenteeritud selgete ja abistavate selgitustega kõikide peamiste sektsioonide ja funktsioonide kohta app.js kood on piisavalt kommenteeritud, sisaldab põhilisi selgitusi enamikule sektsioonidele app.js koodil on minimaalsed kommentaarid ja puuduvad selged selgitused
Koodi organiseerimine Kood on loogilistesse plokkidesse jaotatud, selgete sektsioonide päiste ja ühtse struktuuriga Kood on mõningal määral organiseeritud, sisaldab põhigrupeerimist seotud funktsionaalsuste kohta Kood on osaliselt korrastamata ja raske jälgida
Koodi kvaliteet Kõik muutujad ja funktsioonid on kirjeldavate nimedega, puudub kasutamata kood, järgitakse ühtseid stiilireegleid Enamik koodist kasutab head nimetustava, minimaalselt kasutamata koodi Muutujate nimed on ebaselged, sisaldab kasutamata koodi, stiil on ebaühtlane

Vastutusest loobumine: See dokument on tõlgitud kasutades tehisintellektil põhinevat tõlketeenust Co-op Translator. Kuigi me püüame täpsust, palun arvestage, et automatiseeritud tõlgetes võib esineda vigu või ebatäpsusi. Originaaldokument selle emakeeles tuleks pidada autoriteetseks allikaks. Olulise teabe puhul on soovitatav kasutada professionaalset inimtõlget. Me ei vastuta selle tõlke kasutamisest tingitud väärarusaamade või valesti tõlgendamise eest.