2.8 KiB
Komen Kod Anda
Arahan
Kod yang bersih dan didokumentasikan dengan baik adalah penting untuk mengekalkan dan berkongsi projek anda. Dalam tugasan ini, anda akan mempraktikkan salah satu tabiat paling penting bagi pembangun profesional: menulis komen yang jelas dan berguna yang menerangkan tujuan dan fungsi kod anda.
Semak fail app.js semasa anda dalam folder permainan anda, dan cari cara untuk menambah komen dan merapikannya. Sangat mudah untuk kod menjadi tidak teratur, dan sekarang adalah peluang yang baik untuk menambah komen bagi memastikan kod anda mudah dibaca supaya anda boleh menggunakannya kemudian.
Tugas anda termasuk:
- Tambah komen yang menerangkan apa yang dilakukan oleh setiap bahagian utama kod
- Dokumentasikan fungsi dengan penerangan yang jelas tentang tujuan dan parameternya
- Susun kod ke dalam blok logik dengan tajuk bahagian
- Buang sebarang kod yang tidak digunakan atau berlebihan
- Gunakan penamaan yang konsisten untuk pembolehubah dan fungsi
Rubrik
| Kriteria | Cemerlang | Memadai | Perlu Penambahbaikan |
|---|---|---|---|
| Dokumentasi Kod | Kod app.js sepenuhnya dikomen dengan penerangan yang jelas dan berguna untuk semua bahagian utama dan fungsi |
Kod app.js dikomen dengan memadai dengan penerangan asas untuk kebanyakan bahagian |
Kod app.js mempunyai komen yang minimum dan kekurangan penerangan yang jelas |
| Organisasi Kod | Kod disusun ke dalam blok logik dengan tajuk bahagian yang jelas dan struktur yang konsisten | Kod mempunyai beberapa organisasi dengan pengelompokan asas fungsi berkaitan | Kod agak tidak teratur dan sukar diikuti |
| Kualiti Kod | Semua pembolehubah dan fungsi menggunakan nama yang deskriptif, tiada kod yang tidak digunakan, mengikuti konvensyen yang konsisten | Kebanyakan kod mengikuti amalan penamaan yang baik dengan kod yang tidak digunakan yang minimum | Nama pembolehubah tidak jelas, mengandungi kod yang tidak digunakan, gaya tidak konsisten |
Penafian:
Dokumen ini telah diterjemahkan menggunakan perkhidmatan terjemahan AI Co-op Translator. Walaupun kami berusaha untuk ketepatan, sila ambil perhatian bahawa terjemahan automatik mungkin mengandungi kesilapan atau ketidaktepatan. Dokumen asal dalam bahasa asalnya harus dianggap sebagai sumber yang berwibawa. Untuk maklumat penting, terjemahan manusia profesional adalah disyorkan. Kami tidak bertanggungjawab atas sebarang salah faham atau salah tafsir yang timbul daripada penggunaan terjemahan ini.