2.8 KiB
Beri Komentar pada Kode Anda
Instruksi
Kode yang bersih dan terdokumentasi dengan baik sangat penting untuk menjaga dan membagikan proyek Anda. Dalam tugas ini, Anda akan berlatih salah satu kebiasaan terpenting dari pengembang profesional: menulis komentar yang jelas dan bermanfaat yang menjelaskan tujuan dan fungsi kode Anda.
Tinjau file app.js Anda saat ini di folder game Anda, dan cari cara untuk memberikan komentar serta merapikannya. Sangat mudah bagi kode untuk menjadi tidak teratur, dan sekarang adalah kesempatan yang baik untuk menambahkan komentar agar kode Anda mudah dibaca sehingga dapat digunakan di kemudian hari.
Tugas Anda meliputi:
- Tambahkan komentar yang menjelaskan apa yang dilakukan setiap bagian utama kode
- Dokumentasikan fungsi dengan deskripsi yang jelas tentang tujuan dan parameter mereka
- Organisasikan kode ke dalam blok logis dengan header bagian
- Hapus kode yang tidak digunakan atau berlebihan
- Gunakan konvensi penamaan yang konsisten untuk variabel dan fungsi
Rubrik
| Kriteria | Unggul | Memadai | Perlu Peningkatan |
|---|---|---|---|
| Dokumentasi Kode | Kode app.js sepenuhnya diberi komentar dengan penjelasan yang jelas dan bermanfaat untuk semua bagian utama dan fungsi |
Kode app.js diberi komentar dengan penjelasan dasar untuk sebagian besar bagian |
Kode app.js memiliki komentar minimal dan kurang penjelasan yang jelas |
| Organisasi Kode | Kode diorganisasikan ke dalam blok logis dengan header bagian yang jelas dan struktur yang konsisten | Kode memiliki beberapa organisasi dengan pengelompokan dasar fungsi terkait | Kode agak tidak terorganisasi dan sulit diikuti |
| Kualitas Kode | Semua variabel dan fungsi menggunakan nama yang deskriptif, tidak ada kode yang tidak digunakan, mengikuti konvensi yang konsisten | Sebagian besar kode mengikuti praktik penamaan yang baik dengan kode yang tidak digunakan minimal | Nama variabel tidak jelas, mengandung kode yang tidak digunakan, gaya tidak konsisten |
Penafian:
Dokumen ini telah diterjemahkan menggunakan layanan penerjemahan AI Co-op Translator. Meskipun kami berupaya untuk memberikan hasil yang akurat, harap diketahui bahwa terjemahan otomatis mungkin mengandung kesalahan atau ketidakakuratan. Dokumen asli dalam bahasa aslinya harus dianggap sebagai sumber yang otoritatif. Untuk informasi yang bersifat kritis, disarankan menggunakan jasa penerjemahan manusia profesional. Kami tidak bertanggung jawab atas kesalahpahaman atau penafsiran yang timbul dari penggunaan terjemahan ini.