1. Learn
  2. Quick Notes
  3. List
  4. Menghasilkan atur cara yang mudah dibaca dengan menggunakan gaya yang baik (komen, nama pembolehubah yang bermakna, inden)

Amalan Terbaik Pengaturcaraan

 
1.5 Amalan Terbaik Pengaturcaraan
 
Maksud Amalan Terbaik Pengaturcaraan
Amalan terbaik pengaturcaraan ialah apabila peraturan dapat mempraktikkan amalan-amalan yang biasa diikuti untuk menghasilkan atur cara yang baik.
 
Faktor-Faktor yang Mempengaruhi Kebolehbacaan Kod Atur Cara
Inden yang Konsisten
  • Penggunaan inden yang konsisten membuatkan kod atur cara mudah dibaca dan difahami oleh pengguna yang lain.
  • Cara menulis inden yang konsisten dari awal hingga ke akhir kod.
Jenis Data
  • Pilih jenis data yang sesuai supaya saiz pemboleh ubah tidak terlampau besar atau kecil dan memelihara sumber (conserve resources).
Pemboleh Ubah yang Bermakna
  • Skop biarlah kecil untuk mengelakkan kekeliruan dan mudah diselenggara.
  • Tidak bermula dengan nombor.
  • Tiada ruang kosong antara perkataan. Underscore (_) digunakan jika terdapat lebih dari 1 perkataan atau rapatkan perkataan.
  • Tidak sama kata kunci dalam Java.
  • Penggunaan huruf kecil dengan huruf besar.
  • Nama yang bermakna dan mudah difahami. Penggunaan perkataan singkat tidak digalakkan.
  • Tidak boleh terdiri daripada ruang kosong dan perkataan rizab/khas.
Komen
  • Komen pemboleh ubah ditulis dengan jelas dalam 2 hingga 3 baris pendek untuk menerangkan fungsi kod dan memenuhi ruang lajur pengekodan.
 
1.5.1  Jenis Ralat dalam Atur Cara
  • Ralat yang sering berlaku semasa proses pengaturcaraan terbahagi kepada tiga jenis iaitu:
    • Sintaks.
    • Masa larian.
    • Logik.
Ralat Sintaks
  • Ralat berlaku akibat perkara berikut:
    • Kesalahan tatabahasa.
    • Penggunaan objek atau aksara yang tidak dikenali.
Ralat Masa Larian
  • Ralat yang ditemui ketika atur cara yang sedang berjalan terganggu akibat beberapa faktor.
  • Berlaku sekiranya pengatur cara cuba untuk melaksanakan operasi aritmetik yang mustahil.
  • Contohnya seperti yang berikut:
    • Pengiraan data bukan berangka (non-numerical).
    • Pembahagian dengan digit 0.
    • Mencari punca kuasa 2 bagi nombor negatif.
Ralat Logik
  • Berlaku apabila atur cara tidak berfungsi seperti yang diingini.
  • Tidak dapat dikesan atau jarang dikesan oleh pengkompil.
  • Pengatur cara sahaja yang boleh mengesan ralat logik melalui output yang dihasilkan.
  • Sekiranya output yang dihasilkan tidak menepati apa yang diinginkan, pengatur cara perlu memeriksa semua aspek output projek tersebut seperti pengiraan, teks dan penjarakan (spacing).
 
1.5.2  Pengesanan, Pengenalpastian dan Penterjemahan Mesej Ralat serta Pembaikan Ralat
Imej ini menunjukkan langkah-langkah pengesanan mesej ralat dalam bahasa Melayu. Terdapat lima langkah yang dinyatakan dalam bentuk bulatan berangka dari 01 hingga 05, disusun secara mendatar. Setiap langkah disertakan dengan penerangan ringkas: 1. Semak semula atur cara pada bahagian pengisytiharan. 2. Pastikan nama pemboleh ubah yang diisytiharkan adalah sama dengan nama yang akan dipanggil balik dalam atur cara. 3. Pastikan semua tatatanda ditulis dengan lengkap. 4. Setelah ralat dikenal pasti, ralat sintaks boleh dibaiki. 5. Setelah mengesan dan membaiki ralat sintaks
 
1.5.3  Mengenal Pasti Nilai bagi Pemboleh Ubah pada Bahagian Tertentu Atur Cara
  • Pemboleh ubah digunakan untuk menyimpan data input dan data output.
  • Dalam pengaturcaraan, pemboleh ubah digunakan sebagai pemudah cara bagi komputer untuk menerima, menghantar, memproses dan menyebabkan operasi terhadap sesuatu input.
  • Sekiranya pengguna memasukkan nilai pemboleh ubah yang diingini, pemproses akan memproses nilai data input itu dan mengeluarkan suatu nilai baharu iaitu output.
 
1.5.4  Penghasilan Atur Cara yang Mudah Dibaca dengan Menggunakan Gaya yang Baik (Komen, Nama Pemboleh Ubah yang Bermakna dan Inden)
  • Untuk menghasilkan atur cara yang baik dan mudah difahami, pengatur cara perlu menggunakan gaya yang baik seperti yang berikut:
    • Meletakkan komen pada setiap fungsi yang dibuat.
    • Menggunakan nama pemboleh ubah yang bermakna.
    • Menggunakan inden yang selesa untuk dibaca.
Meletakkan Komen pada Setiap Fungsi yang Dibuat
  • Merujuk penanda yang dibuat oleh pengatur cara untuk setiap atur cara yang dibina.
  • Komen merujuk penanda yang dibuat oleh pengatur cara untuk setiap atur cara yang dibina.
  • Setiap bahasa pengaturcaraan mempunyai kod yang khusus untuk komen. Dalam pengaturcaraan Java, kod komen perlu menggunakan sintaks yang telah ditetapkan.
  • Sekiranya sintaks tersebut tidak dimasukkan pada baris komen dalam atur cara tersebut, sistem akan mengeluarkan ralat sintaks/kompil.
  • Tatatanda komen dalam Java perlu dilakukan dengan betul.
  • Terdapat tiga gaya tatatanda komen yang boleh digunakan seperti yang ditunjukkan di bawah:
Jenis Komen Huraian
// Pengisytiharan pemboleh ubah Pengkompil mengabaikan semua teks bermula dengan tatatanda // hingga ke teks terakhir dalam baris yang sama.
/* Pengisytiharan pemboleh ubah*/ Pengkompil mengabaikan semua teks yang berada dalam /* hingga ke /* walaupun dalam baris yang berlainan.
/** Pengisytiharan pemboleh ubah*/ Komen ini ialah komen dokumentasi. Pengkompil mengabaikan komen jenis ini sama seperti komen yang menggunakan /* dan */.
Menggunakan Nama Pemboleh Ubah yang Bermakna
  • Pengatur cara perlu memikirkan nama pemboleh ubah yang mempunyai ejaan yang ringkas dan bermakna semasa menulis atur cara.
Menggunakan Inden yang Selesa untuk Dibaca
  • Inden merujuk cara penulisan atur cara yang memudahkan pembacaan.
  • Pembacaan atur cara akan dimulakan dengan inden iaitu barisan teks berada di beberapa kedudukan aksara ke dalam dari jidar kiri atau kanan halaman.
 
The views expressed in the notes here are those of the contributor and don’t necessarily represent the views of pandai.

Amalan Terbaik Pengaturcaraan

 
1.5 Amalan Terbaik Pengaturcaraan
 
Maksud Amalan Terbaik Pengaturcaraan
Amalan terbaik pengaturcaraan ialah apabila peraturan dapat mempraktikkan amalan-amalan yang biasa diikuti untuk menghasilkan atur cara yang baik.
 
Faktor-Faktor yang Mempengaruhi Kebolehbacaan Kod Atur Cara
Inden yang Konsisten
  • Penggunaan inden yang konsisten membuatkan kod atur cara mudah dibaca dan difahami oleh pengguna yang lain.
  • Cara menulis inden yang konsisten dari awal hingga ke akhir kod.
Jenis Data
  • Pilih jenis data yang sesuai supaya saiz pemboleh ubah tidak terlampau besar atau kecil dan memelihara sumber (conserve resources).
Pemboleh Ubah yang Bermakna
  • Skop biarlah kecil untuk mengelakkan kekeliruan dan mudah diselenggara.
  • Tidak bermula dengan nombor.
  • Tiada ruang kosong antara perkataan. Underscore (_) digunakan jika terdapat lebih dari 1 perkataan atau rapatkan perkataan.
  • Tidak sama kata kunci dalam Java.
  • Penggunaan huruf kecil dengan huruf besar.
  • Nama yang bermakna dan mudah difahami. Penggunaan perkataan singkat tidak digalakkan.
  • Tidak boleh terdiri daripada ruang kosong dan perkataan rizab/khas.
Komen
  • Komen pemboleh ubah ditulis dengan jelas dalam 2 hingga 3 baris pendek untuk menerangkan fungsi kod dan memenuhi ruang lajur pengekodan.
 
1.5.1  Jenis Ralat dalam Atur Cara
  • Ralat yang sering berlaku semasa proses pengaturcaraan terbahagi kepada tiga jenis iaitu:
    • Sintaks.
    • Masa larian.
    • Logik.
Ralat Sintaks
  • Ralat berlaku akibat perkara berikut:
    • Kesalahan tatabahasa.
    • Penggunaan objek atau aksara yang tidak dikenali.
Ralat Masa Larian
  • Ralat yang ditemui ketika atur cara yang sedang berjalan terganggu akibat beberapa faktor.
  • Berlaku sekiranya pengatur cara cuba untuk melaksanakan operasi aritmetik yang mustahil.
  • Contohnya seperti yang berikut:
    • Pengiraan data bukan berangka (non-numerical).
    • Pembahagian dengan digit 0.
    • Mencari punca kuasa 2 bagi nombor negatif.
Ralat Logik
  • Berlaku apabila atur cara tidak berfungsi seperti yang diingini.
  • Tidak dapat dikesan atau jarang dikesan oleh pengkompil.
  • Pengatur cara sahaja yang boleh mengesan ralat logik melalui output yang dihasilkan.
  • Sekiranya output yang dihasilkan tidak menepati apa yang diinginkan, pengatur cara perlu memeriksa semua aspek output projek tersebut seperti pengiraan, teks dan penjarakan (spacing).
 
1.5.2  Pengesanan, Pengenalpastian dan Penterjemahan Mesej Ralat serta Pembaikan Ralat
Imej ini menunjukkan langkah-langkah pengesanan mesej ralat dalam bahasa Melayu. Terdapat lima langkah yang dinyatakan dalam bentuk bulatan berangka dari 01 hingga 05, disusun secara mendatar. Setiap langkah disertakan dengan penerangan ringkas: 1. Semak semula atur cara pada bahagian pengisytiharan. 2. Pastikan nama pemboleh ubah yang diisytiharkan adalah sama dengan nama yang akan dipanggil balik dalam atur cara. 3. Pastikan semua tatatanda ditulis dengan lengkap. 4. Setelah ralat dikenal pasti, ralat sintaks boleh dibaiki. 5. Setelah mengesan dan membaiki ralat sintaks
 
1.5.3  Mengenal Pasti Nilai bagi Pemboleh Ubah pada Bahagian Tertentu Atur Cara
  • Pemboleh ubah digunakan untuk menyimpan data input dan data output.
  • Dalam pengaturcaraan, pemboleh ubah digunakan sebagai pemudah cara bagi komputer untuk menerima, menghantar, memproses dan menyebabkan operasi terhadap sesuatu input.
  • Sekiranya pengguna memasukkan nilai pemboleh ubah yang diingini, pemproses akan memproses nilai data input itu dan mengeluarkan suatu nilai baharu iaitu output.
 
1.5.4  Penghasilan Atur Cara yang Mudah Dibaca dengan Menggunakan Gaya yang Baik (Komen, Nama Pemboleh Ubah yang Bermakna dan Inden)
  • Untuk menghasilkan atur cara yang baik dan mudah difahami, pengatur cara perlu menggunakan gaya yang baik seperti yang berikut:
    • Meletakkan komen pada setiap fungsi yang dibuat.
    • Menggunakan nama pemboleh ubah yang bermakna.
    • Menggunakan inden yang selesa untuk dibaca.
Meletakkan Komen pada Setiap Fungsi yang Dibuat
  • Merujuk penanda yang dibuat oleh pengatur cara untuk setiap atur cara yang dibina.
  • Komen merujuk penanda yang dibuat oleh pengatur cara untuk setiap atur cara yang dibina.
  • Setiap bahasa pengaturcaraan mempunyai kod yang khusus untuk komen. Dalam pengaturcaraan Java, kod komen perlu menggunakan sintaks yang telah ditetapkan.
  • Sekiranya sintaks tersebut tidak dimasukkan pada baris komen dalam atur cara tersebut, sistem akan mengeluarkan ralat sintaks/kompil.
  • Tatatanda komen dalam Java perlu dilakukan dengan betul.
  • Terdapat tiga gaya tatatanda komen yang boleh digunakan seperti yang ditunjukkan di bawah:
Jenis Komen Huraian
// Pengisytiharan pemboleh ubah Pengkompil mengabaikan semua teks bermula dengan tatatanda // hingga ke teks terakhir dalam baris yang sama.
/* Pengisytiharan pemboleh ubah*/ Pengkompil mengabaikan semua teks yang berada dalam /* hingga ke /* walaupun dalam baris yang berlainan.
/** Pengisytiharan pemboleh ubah*/ Komen ini ialah komen dokumentasi. Pengkompil mengabaikan komen jenis ini sama seperti komen yang menggunakan /* dan */.
Menggunakan Nama Pemboleh Ubah yang Bermakna
  • Pengatur cara perlu memikirkan nama pemboleh ubah yang mempunyai ejaan yang ringkas dan bermakna semasa menulis atur cara.
Menggunakan Inden yang Selesa untuk Dibaca
  • Inden merujuk cara penulisan atur cara yang memudahkan pembacaan.
  • Pembacaan atur cara akan dimulakan dengan inden iaitu barisan teks berada di beberapa kedudukan aksara ke dalam dari jidar kiri atau kanan halaman.
 
The views expressed in the notes here are those of the contributor and don’t necessarily represent the views of pandai.
Chapter : Pengaturcaraan
Topic : Menghasilkan atur cara yang mudah dibaca dengan menggunakan gaya yang baik (komen, nama pembolehubah yang bermakna, inden)
Form 4 Sains Komputer
Related notes

Report this note
Quiz Battle

Challenge your friend in timed Quiz battle

Learn more
Register for a free Pandai account now
© 2024 Pandai.org All Rights Reserved

Quiz
Videos
Notes
Account