Cara menggunakan clean code php

Cara menggunakan clean code php

Ketika kamu memilih menjadi seorang programmer, saat itu pula berarti kamu siap mendedikasikan jiwa dan raga untuk menulis kode program selama sisa hidupmu. Kode program akan menjadi bagian terbesar yang mendominasi pikiranmu. Pagi, siang, maupun malam kamu akan menghabiskan waktumu bersama kode program. Biasanya, programmer harus melanjutkan kode program dari programmer lain. Sebuah keberuntungan, ketika kita menemukan kode yang jelas dan terstruktur. Sebaliknya, ketika program yang kita temui “kurang bersahabat”, tentu kita akan kesulitan dalam melanjutkan project tersebut. Menyusahkan bukan? Itulah sedikit alasan mengapa kita harus mengetahui sebuah seni menerapkan “Clean Code”.

  • Bad Code VS Clean Code
  • Seni Menulis Clean Code
    • 1. Aturan Penamaan
    • 2. Aturan komentar
    • 3. Single Responsibility Principle (SRP)
    • 4. Readability
    • 5. If
    • 6. Well-Organized Project
    • 7. Hapus kode yang Tidak diperlukan

Bad Code VS Clean Code

Setiap programmer memiliki ciri khas programnya masing-masing. Ada programmer yang suka menulis kode program dengan jelas. Namun, ada juga tipe programmer yang “penting jalan” tanpa memperhatikan bentuk penulisan kodenya. Kode program seperti inilah yang disebut dengan istilah bad code. Bad code ini akan menjadi nightmare bagi programmer yang akan melanjutkan kode program sebelumnya.

Cara menggunakan clean code php

Bad code akan sering ditemui atau bahkan diproduksi sendiri, apalagi ketika sudah mendekati deadline. Tipe menulis asal-asalan ini akan menjerumuskan kita pada  bugs yang meningkat. Tak jarang juga kita akan bingung sendiri melihat kode program buatan sendiri. Akhirnya banyak waktu yang akan terbuang untuk fixing bugs ini dan waktu akan makin molor.

Kebalikan bad code disebut clean code. Sebagai seorang programmer baik junior ataupun experienced, cobalah untuk menjadi good programmer. Programmer harus bertanggungjawab atas kode yang ditulisnya. Clean code inilah bentuk pertanggungjawaban ini. Selain kode yang lebih jelas dan terarah, clean code juga mampu mengurangi produksi bugs dan mempercepat software development. Jadi, lebih pilih mana?

Cara menggunakan clean code php
Perbandingan Clean Code VS Bad Code (Sumber : Geeks For Geeks)

Clean code akan sangat berguna untuk membut kode kita lebih readable. Potongan kode akan menjadi jelas dan lebih terbaca. Terlebih ketika mengerjakan project secara tim, clean code ini hukumnya menjadi “wajib ‘ain fardhu kifayah”. Percayalah, bad code akan membuat silaturahmi dengan programmer lain menjadi renggang!

Seni Menulis Clean Code

Ada 7 aturan paling umum untuk menulis clean code yang harus kita ketahui

1. Aturan Penamaan

Kesalahan ini adalah kesalahan paling umum terjadi. Biasakan menulis nama variable, fungsi, maupun method secara jelas dan deskriptif. Penamaan ini harus memiliki arti yang sesuai dengan tujuan pembuatan.

Cara menggunakan clean code php

2. Aturan komentar

Seringkali kita mengabaikan pemberian komentar pada header program maupun awal fungsi/method. Padahal komentar ini adalah satu-satunya kompas saat kita harus melanjutkan project lama loh. Tuliskan komentar dengan jelas

Cara menggunakan clean code php

3. Single Responsibility Principle (SRP)

Setiap fungsi, method, ataupun variable harus secara spesifik bertanggungjawab atas satu pekerjaan. Hindari penggunaan nested structure atau maksimal memiliki dua level indent. Jika suatu fungsi dapat melakukan lebih dari satu pekerjaan, fixing bugs akan lebih sulit karena kita akan berhadapan dengan banyak step. Selain itu, usahakan satu fungsi maksimal hanya 3 parameter saja.

Cara menggunakan clean code php

4. Readability

Buat kode program menyenangkan untuk dibaca, bahkan untuk beginner programmer. Indentation, whitespace, dan line breaks adalah hal-hal yang harus diperhatikan agar kode program kita selalu terlihat rapi.

Cara menggunakan clean code php

5. If

Tuliskan percabangan pada if dengan jelas. Perhatikan contoh berikut

Cara menggunakan clean code php

Pada kolom bad code program (kanan) akan mengecek terus menerus walaupun kondisi sudah terpenuhi, sedangkan untuk clean code program (kiri) akan berhenti mengecek jika kondisi sudah dipenuhi.

6. Well-Organized Project

Aturan keenam ini juga merupakan aturan yang tidak boleh terlewatkan. Selama proses pengembangan, kita seringkali menambahkan file ataupun folder ke project yang kita buat. Penataan file yang berantakan seringkali membuat programmer lain kebingungan dengan project kita. Well-Organized Project akan membuat semuanya menjadi jelas dan updating lebih mudah.

7. Hapus kode yang Tidak diperlukan

Selama trial project, tentu kita menambahkan banyak kode untuk mencapai keberhasilan. Mungkin kita akan merasa “sayang” untuk menghapus sisa-sisa perang ini. Biasanya kita hanya akan meng-comment potongan kode ini. Jika hanya sekali dua kali masih tidak begitu terasa, namun bagaimana jika ternyata kita tidak sadar melakukan hal ini pada 300 kelas? Mengerikan bukan? Oleh karena itu, biasakan menghapus kode-kode tidak berguan ini ya. Tapi jangan sampai menghapus potongan kode ini membuat error ya..

Nah, itu dia Sebuah Seni Menerapkan “Clean Code”. Semoga setelah membaca ini kalian hijrah ke jalan yang benar yaa !

Mungkin Anda Juga Suka : Kuliah IT Tapi Gasuka Coding ? Ini Dia Pekerjaan Buat Kamu !

Baca Juga : Clean Code