Sebagai programmer pemula, saya sering membuat struktur kodingan yang boleh dikatakan ‘bar-bar’ sehingga menyulitkan saya sendiri untuk mengedit ulang kode tersebut bahkan kadang harus merombaknya dan menulisnya dari awal.
Seseorang yang pernah sekolah di luar negeri pernah memberi saya beberapa tips mengenai cara manajemen sebuah bahasa pemrograman yang baik, dalam hal ini saya memakai contoh bahasa C#.
// Gunakan huruf awal besar untuk variabel public public int Test; // Gunakan huruf awal kecil untuk variabel private private int test;
Perhatikan bahwa nilai test yang di deklarasi dalam sebuah kelas disetel oleh nilai test dari dalam fungsi. Manfaatnya adalah untuk mencegah penggunaan variabel yang ambigu ketika ada dua variabel yang bernama sama namun tempat pendeklarasiannya berbeda (yang satu di dalam kelas, yang satu lagi di dalam fungsi).
// Pendeklarasian dalam kelas public int Test = 0; // Penggunaan keyword "this" this.Test = 1; // Kegunaan sebagai pembeda dengan deklarasi variabel fungsi private void SetTestValue (int test) { this.Test = test; }
Singkatnya, kata kunci “this” merujuk kepada variabel yang di deklarasi di kelas dan bukan yang di dalam fungsi.
Nama fungsi harus di awali dengan huruf kapital dan dengan nama yang mudah dimengerti seseorang. Contohnya jika ada fungsi tentang operasi penjumlahan, cukup tulis nama fungsi Jumlahkan(nilaiA, nilaiB) atau jika dalam bahasa Inggris cukup Add(valueA, valueB). Sehingga nama fungsi lebih simpel lebih baik.
// Pemanggilan fungsi Add(3, 5); // Hasil output adalah 8 // Pendeklarasian fungsi yang memakai huruf awal besar public int Add (int a, int b) { return a + b; } // Contoh yang lain, gunakan kata SetXX untuk menyetel nilai. SetValue(); SetObject(); SetControllable(); // Dan lebih baik agar tidak ditulis seperti ini AssignValue(); EnterObject(); // karena mungkin dapat 'bentrok' dengan nama fungsi lain // atau membingungkan orang
Jadilah programmer yang baik dan tidak menyusahkan, penambahan komentar dapat membantu dirimu sendiri dan orang lain. Umumnya komentar dapat ditambahkan hanya dengan menambah dua buah garis miring (slash) di depan komentar. Hal ini ditujukan agar baris yang dikomentari tidak di-compile dan menimbulkan error.
// Jelaskan baris ini maksudnya apa, seperti // Setel nilai test private int test = 0; // Kemudian tambahkan sebanyak 5 test += 5; // Setelah ditambahkan, bla... bla... bla...
Mungkin terlihat begitu sepele, namun kurangnya komentar akan berakibat bencana jika seseorang membuat kode sekitar ribuan baris.
Sangat dianjurkan untuk tidak menghapus kode yang kemungkinan masih dapat digunakan kembali, gunakan komentar untuk menjadikannya tidak terdeteksi compiler.
// Kode yang terpakai public int Test = 0; // Kode yang tidak terpakai, // namun mungkin masih dapat digunakan // private int test = 0;
Biasanya banyak pemula yang memakai nilai ajaib atau magic value, sebenarnya tidak begitu jadi masalah jika konsekuensinya bagus. Namun sangat dianjurkan agar mendeklarasi constant untuk menjadikannya lebih rapi.
// Pendeklarasian variabel normal public int Test = 0; // Contoh pendeklarasian constant (c#) private const int TEST_CONST = 7; // Tidak dianjurkan untuk seperti ini this.Test = 7; // Tetapi pakailah constant this.Test = TEST_CONST;
Penulisan constant adalah dengan huruf besar seluruhnya dan jika memakai pemisah, gunakanlah underscore. Pastikan nilai constant selalu tetap bagaimanapun kondisinya, karenanya bisa dibuat variabel statis.
Pemula biasanya menggunakan if…else jika terdapat kondisi, sebanyak apapun kondisi tersebut. Gunakanlah switch…case dikarenakan lebih intensif dan efisien khusus untuk kondisi yang sangat kompleks.
public int Test = 0; public string Text = string.empty; // Kondisi biasa yang tidak dianjurkan if (this.Test == 0) this.Text = "Hello"; else if (this.Text == 1) this.Text = "World"; else this.Text = "Indonesia"; // Memakai switch case switch (this.Test) { case 0 : this.Text = "Hello"; break; case 1 : this.Text = "World"; break; case 2 : this.Text = "Indonesia"; break; }
Perlu diingat bahwa setiap case harus ditutup dengan break. Ini dimaksudkan agar kode dari case berikutnya tidak tereksekusi. Singkatnya, ini sama saja dengan kurawal tutup dari setiap statement dari if. Untuk case yang memiliki nilai sama, cukup ditulis seperti ini :
// Jika memakai if dan ada kondisi sama if (this.Test == 0 && this.Test == 1) { // kode dijalankan di sini. } // Jika memakai switch dan ada kondisi sama switch (this.Test) { case 0 : case 1 : // kode dijalankan disini break; }
Ini akan membuat tampilan kode menjadi lebih rapi dan indah.
// Buatlah indentasi seperti ini if (this.Test == 0) { this.Text = "Hello"; if (this.Text == "Hello") this.autoRun = true; } // Dan jangan seperti ini if (this.Test == 0) { this.Text = "Hello"; if (this.Text == "Hello") this.autoRun = true; } // Selalu beri spasi antara koma dan operasi if (this.Test > 0) { this.Test = Add(3, 5); this.Test += 4; } // Dan jangan seperti ini if (this.Test>0) { this.Test=Add(3,5); this.Test+=4; }
Semoga bermanfaat