3.2 KiB
Magkomento sa Iyong Code
Mga Instruksyon
Ang malinis at maayos na dokumentadong code ay mahalaga para sa pagpapanatili at pagbabahagi ng iyong mga proyekto. Sa gawaing ito, magsasanay ka sa isa sa pinakamahalagang ugali ng mga propesyonal na developer: ang pagsusulat ng malinaw at kapaki-pakinabang na mga komento na nagpapaliwanag sa layunin at functionality ng iyong code.
Suriin ang kasalukuyang app.js file sa iyong game folder, at hanapin ang mga paraan upang magdagdag ng mga komento at ayusin ito. Napakadaling mawalan ng kontrol sa code, kaya magandang pagkakataon ito upang magdagdag ng mga komento upang matiyak na mayroon kang nababasang code na magagamit mo sa hinaharap.
Ang iyong gawain ay kinabibilangan ng:
- Magdagdag ng mga komento na nagpapaliwanag kung ano ang ginagawa ng bawat pangunahing bahagi ng code
- Idokumento ang mga function gamit ang malinaw na paglalarawan ng kanilang layunin at mga parameter
- Ayusin ang code sa lohikal na mga bloke na may mga header ng seksyon
- Tanggalin ang anumang hindi nagagamit o labis na code
- Gumamit ng pare-parehong mga convention sa pagbibigay ng pangalan para sa mga variable at function
Rubric
| Pamantayan | Napakahusay | Katamtaman | Kailangan ng Pagpapabuti |
|---|---|---|---|
| Dokumentasyon ng Code | Ang app.js code ay ganap na may mga komento na may malinaw at kapaki-pakinabang na paliwanag para sa lahat ng pangunahing bahagi at function |
Ang app.js code ay may sapat na mga komento na may mga pangunahing paliwanag para sa karamihan ng mga bahagi |
Ang app.js code ay may kaunting mga komento at kulang sa malinaw na paliwanag |
| Organisasyon ng Code | Ang code ay nakaayos sa lohikal na mga bloke na may malinaw na mga header ng seksyon at pare-parehong istruktura | Ang code ay may ilang organisasyon na may pangunahing pangkat ng mga kaugnay na functionality | Ang code ay medyo magulo at mahirap sundan |
| Kalidad ng Code | Lahat ng mga variable at function ay gumagamit ng mga deskriptibong pangalan, walang hindi nagagamit na code, sumusunod sa pare-parehong mga convention | Karamihan sa code ay sumusunod sa magagandang kasanayan sa pagbibigay ng pangalan na may kaunting hindi nagagamit na code | Ang mga pangalan ng variable ay hindi malinaw, naglalaman ng hindi nagagamit na code, hindi pare-pareho ang estilo |
Paunawa:
Ang dokumentong ito ay isinalin gamit ang AI translation service na Co-op Translator. Bagamat sinisikap naming maging tumpak, pakatandaan na ang mga awtomatikong pagsasalin ay maaaring maglaman ng mga pagkakamali o hindi pagkakatugma. Ang orihinal na dokumento sa kanyang katutubong wika ang dapat ituring na opisyal na sanggunian. Para sa mahalagang impormasyon, inirerekomenda ang propesyonal na pagsasalin ng tao. Hindi kami mananagot sa anumang hindi pagkakaunawaan o maling interpretasyon na dulot ng paggamit ng pagsasaling ito.