Sebagai programmer kadang kala kita tidak memperhatikaan sudah sampai berapa baris kode program yang telah kita buat dan tanpa terasa baris kode yang kita buat mencapai seribu atau bahkan jutaan baris kode. Tapi apakah kalian pernah merasakan ketika membuat kode program tanpa memperhatikan kerapiannya, bisa jadi karena ingin cepat menyelesaikan program tersebut atau bahkan dikejar deadline untuk menyelesaikannya.

 

  1. Tulis Sesingkat Mungkin

Semakin sesingkat sebuah kode, maka akan semakin mudah kode tersebut dibaca (baik oleh compiler maupun oleh developer). Tulislah kode anda sesingkat mungkin agar proses compiling kode anda jauh lebih cepat. Maksimalkan juga built-in function yang telah disediakan oleh bahasa pemrograman yang digunakan.

 

  1. Readable Function

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.

 

  1. 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.

 

  1. 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.

 

  1. 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.

 

  1. 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.

 

  1. 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.

Leave a Reply

Your email address will not be published. Required fields are marked *