9 Etika Menulis Source Code Program

Wah ternyata menulis kode program ada etikanya. Tidak bisa semau gue dong? He-he.
Tidak masalah jika Anda ingin menulis kode program sesuai gaya sendiri. Namun alangkah baiknya jika kita mengikuti beberapa aturan berikut sehingga nantinya bisa membantu programer lain memahami makna karya yang telah Anda buat.
Percuma juga dong kita sudah susah payah menulis suatu program, namun program tersebut tidak bisa di kembangkan oleh orang lain karena gaya penulisan Anda yang ambrul adul (weleh).
Oke, berikut adalah sembilan tips yang bisa Anda ikuti :
1. Tulis Sesimpel dan Seefisien mungkin.
Semakin simpel sebuah kode, maka akan semakin mudah kode tersebut dibaca (baik oleh compiler maupun oleh pembuat). Makanya, mulai sekarang tulis setiap kode anda sesederhana dan seefisien mungkin agar proses compiling kode anda jauh lebih cepat. Maksimalkan juga built-in function yang telah disediakan oleh bahasa pemrograman yang anda gunakan.
2. Readable Function.
Artinya sekali lirik dari namanya, programmer lain sudah harus bisa menebak apa guna dari fungsi tersebut. Fungsi yang anda buat hendaklah bisa dibaca dan dimengerti dengan mudah melalui namanya. Hal ini sangatlah penting, baik bagi anda yang mengikuti gaya prosedural ataupun OOP.
3. Konsisten.
Anda harus konsisten ketika menulis kode. Misalnya dalam memberi nama variabel, nama objek, ukuran objek, perataan kode, penggunaan jenis huruf, case sensitive, dll. Disini, kita bisa menentukan sendiri aturan kita sebelum mulai mengerjakan proyek. Atau kita bisa mengikuti standard penulisan kode yang sudah ada, karena biasanya setiap software house memiliki standard sendiri.
4. Perhatikan text indentation.
Layaknya sebuah desain, kode pun harus ada tabulasi / text indentation agar kode dapat dibaca dengan mudah dan mata tidak terlalu sulit untuk menemukan kode apa yang akan dicari. Terlebih bagi programmer lain yang akan membantu anda, atau meneruskan proyek anda.
5. Tambahkan komentar.
Jika menurut anda poin-poin sebelumnya masih belum bisa menjelaskan fungsi yang anda maksudkan, anda dapat menambahkan komentar-komentar atau keterangan deskriptif mengenai fungsi tersebut dan bagaimana cara menggunakannya. Meskipun ukuran dokumen anda jadi semakin besar, namun dari sini anda meninggalkan petunjuk berupa informasi bagi mereka yang menggunakan kode anda, tanpa harus bertanya-tanya terus pada anda.
6. Penamaan file.
Misalnya file PHP. Dia harus disimpan dengan ekstensi .php (jika anda menemukan file dengan  ekstensi .php3 atau .phtml maka kemungkinan besar file-file tersebut ditulis menggunakan PHP versi 3 ke bawah). File-file tersebut akan disimpan sebagai file teks biasa, artinya kita tidak butuh editor khusus. Namun perlu diingat bahwa Notepad tidak memunculkan nomor baris sehingga jika dibuka kadang seorang programmer tidak bisa begitu saja membaca sebuah kode. Di sinilah anda dapat membantu mereka dengan memberi nama yang deskriptif dan tidak random pada setiap file anda.
7. Buat sebuah dokumentasi.
Jika anda sudah membuat sebuah kode dimana kode tersebut levelnya merupakan framework atau library yang cukup kompleks, maka diperlukan sebuah dokumentasi. Paling tidak, dokumentasi yang anda buat adalah semacam tour guide yang dapat memandu orang lain memanfaatkan kode anda. Lengkapi pula dokumentasi tersebut dengan API (Application Programming Interface) tiap fungsi yang mungkin bisa digunakan.
8. Selalu update.
Artinya, sebagai programmer anda wajib memantau perkembangan terbaru pada bahasa pemrograman yang anda minati. Karena terkadang ada cara-cara penulisan yang akan diatur ulang oleh pihak developer dari bahasa pemrograman yang kita manfaatkan. Lihat saja PHP di tahun 1995 dengan sekarang (anda bisa cek perkembangan PHP pada halaman: http://php.net/manual/en/history.php.php). Jika anda tidak memantau perbedaannya, maka anda bisa sangat ketinggalan sebagian dari profesi anda.
9. Berpikiran universal.
Programmer bukanlah seorang pejuang solo, banyak programmer di dunia ini yang saling membantu dan memanfaatkan kode milik programmer lain. Untuk itu, gunakan gaya penulisan standard yang sudah ditentukan oleh bahasa pemrograman yang anda pakai. Selain anda mengikuti peraturan, anda juga menjadi seorang yang sosialis dalam hal sharing kode anda. Dengan begitu, anda bisa mendapatkan teman serta kode yang anda buat sangat bermanfaat bagi orang lain. Berikut contoh sederhana kode yang menerapkan beberapa etika diatas.

Nah itu tadi adalah beberapa poin-poin yang bisa anda terapkan dalam cara penulisan kode anda. Bagaimana dengan anda? Apakah anda memiliki pengalaman menarik seputar penulisan kode? Mari share pada form komentar dibawah.

2 comments:

Blogger Template by Kerendi Developers