You are here

Yuk Kita Terapkan Hal-Hal Berikut Saat Ngoding

Halo sahabat programer sekalian, kali ini saya akan membagikan tips untuk membuat koding yang maintainable. Nah, bagaimana sih koding yang maintainable itu?

  1. Dapat disebut maintainable apabila kamu sendiri dapat me-maintain-nya,
  2. Apabila orang lain dapat mengurus koding itu tanpa meminta bantuan darimu,
  3. Jika orang lain membacanya, mereka dapat mengerti desain, tata letak, dan maksud dari koding kamu.

Sekarang, bagaimana kita membuat koding yang seperti itu? terapkan hal-hal berikut

1. Commenting & Documentation

   

Dengan menggunakan komen dan dokumentasi pada koding kita dapat mempermudah orang lain dalam memahami apa tujuan dan kegunaan dari koding tersebut.

2. Consistent Indentation

Ada beberapa tipe programer

Style 1 :

Style 2 :

Style 3 :

Tapi itu hanya sekedar pilihan.

There is no “best” style that everyone should be following.

Actually, the best style, is a consistent style.

Jika kamu bagian dari tim atau sedang berkontribusi dalam proyek, maka kamu harus mengikuti style yang sudah ditetapkan atau yang digunakan pada proyek tersebut.

Tapi style tidak sebatas 3 itu saja. Karna terkadang mereka menyatukan beberapa style. Contohnya seperti ini

Sekali lagi, tidak ada parameter untuk menentukan mana style yang terbaik, cukup konsisten dengan style-mu atau ikuti style yang digunakan apabila kamu terlibat dalam pekrjaan tim.

3. Avoid Obvious Comments

Memberi komen pada koding memang sangat bagus. Tapi jangan sampai berlebihan seperti ini

Apabila teks pada kodingnya sudah jelas, sebenarnya tidak perlu diulang dalam komentar. Jika memang ingin memberinya komen pada kodingnya, lebih baik meggabungkannya menjadi satu baris.

4. Code Grouping

Biasanya tasks tertentu memerlukan beberapa baris kode. Nah, sebaiknya kita pisahkan dengan memberi jarak diantaranya.

Dengan menambahkan komentar di awal setiap blok kode juga menekankan pemisahan visual.

5. Consistent Naming Scheme

Pertama-tama, nama harus memiliki batas kata. Ada dua pilihan yang populer :

  • camelCase : huruf pertama dari setiap kata huruf kapital, kecuali kata pertama
  • underscores : menggarisbawahi atara kata-kata, seperti : mysql_real_escape_string().

Jika proyek yang sedang anda kerjakan mengikuti aturan tertentu, maka kamu harus mengikutinya. Selain itu, beberapa platform bahasa cenderung menggunakan skema penamaan tertentu. Misalnya, pada Java kebanyakan kode menggunakan camelCase, sedangkan di PHP mayoritas menggunakan underscores.

Untuk beberapa developer lebih suka menggunakan underscores untuk fungsi prosedural dan nama class, tapi menggunakan camelCase untuk class method :

6. DRY Principle

DRY singkatan dari Don’t Repeat Yourself. Juga dikenal sebagai DIE : Duplication is Evil.

Prinsipnya menyatakan :

“Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.”

Tujuan sebagian besar aplikasi (atau komputer pada umumnya) adalah untuk mengotomatiskan tugas yang berulang. Prinsip ini harus diterapkan dalam semua kode, juga web application. Bagian kode yang sama tidak boleh diulang berkali-kali.

Misalnya, sebagian besar web application terdiri dari banyak halaman. Ini sangat memungkinkan bahwa halaman-halaman ini beriti komponen umum seperti Header dan Footer. Bukan ide yang bagus untuk copy paste Header dan Footer ke setiap halaman. Ini contoh templating pada CodeIgniter

7. Avoid Deep Nesting

Terlalu banyak tingkatan bisa membuat kode lebih sulit dibaca dan diikuti.

Agar mudah dibaca, kita buat perubahan pada kodenya untuk mengurangi tingakatan itu.

8. Limit Line Length

9. File and Folder Organization

Kerapihan dari struktur folder juga penting. Lebih baik kamu meniru struktur folder dari framework atau menggunakan framework itu sendiri.

10. Consistent Temporary Names

Biasanya, variabel harus deskriptif dan mengandung satu atau beberapa kata. Tapi ini tidak harus berlaku untuk variabel sementara. Mereka bisa sesingkat karakter tunggal. Berikut beberapa contoh yang sering digunakan :

11. Capitalize SQL Special Words

Interaksi database adalah bagian besar dari web application. Jika kamu menulis raw SQL queries, itu ide yang bagus untuk membuatnya readable. Dan walaupun kata-kata khusus SQL dan nama dari fungsi tidak sensitif, kita harus tetap membedakannya antara fungsi dari SQL dengan nama tabel dan kolom.

SELECT id, username FROM user;
UPDATE user SET last_login = NOW()
WHERE id = '123'
SELECT id, username FROM user u
LEFT JOIN user_address ua ON(u.id = ua.user_id)
WHERE ua.state = 'NY'
GROUP BY u.id
ORDER BY u.username
LIMIT 0,20

12. Separation of Code and Data

Ini adalah prinsip yang berlaku hampir di setiap bahasa pemrograman. Dalam web development, “data” biasanya merupakan output HTML. Prinsip pemisahan kode dan data ini diterapkan pada alat pihak ketiga (template engines, framework or CMS). Akan lebih mudah jika kalian memakai alat pihak ketiga tersebut dan mengikuti aturannya.

Popular PHP framework :

  • CodeIgniter
  • Zend Framework
  • Cake PHP
  • Symfony
  • Laravel

Popular Template Engines :

  • Smarty
  • Dwoo
  • Savant

13. Alternate Syntax Inside Templates

Kamu bisa menggunakan cara inline PHP untuk ditempatkan pada template. Ini tidak melanggar prinsip “Separation of Code and Data” selama kode inline tersebut terhubung langsung dengan output, dan tentunya readable.

Cara itu dapat merapihkan inline PHP pada template. Selain itu kodenya pun terlihat dan terasa mirip dengan struktur HTML aslinya.

14. Object Oriented + Procedural

Object Oriented Programing dapat membantu kamu untuk membuat kode terstruktur dengan baik. Tapi bukan berarti kita tidak perlu menggunakan Procedural Programing. Sebenarnya membuat perpaduan antara keduanya merupakan ide yang bagus.

Object harus digunakan untuk mewakili data, biasanya berada dalam database.

Fungsi procedural dapat digunakan untuk tasks tertentu yang dapat dilakukan terpisah.

Nah, seperti itulah tips untuk membuat koding yang maintainable juga readable. Intinya kita harus konsisten dengan cari kita ngoding dan ikuti aturan dari framework bila kita menggunakannya. Apabila kita bagian dari tim yang sedang mengerjakan proyek, maka kita harus ikuti aturan yang telah disepakati.

Sekian tips yang dapat saya sampaikan pada artikel ini, semoga bermanfaat. Jangan lupa komen dan bagikan artikel ini yaa.

Salam Programer,

Leave a Reply

Top