Konsep “CLEAN CODE” dengan PHP

Gambar teks book

CLEAN CODE adalah konsep yang merujuk pada kode yang ditulis dengan cara yang mudah dibaca, dipahami, dan dipelihara.
Konsep ini didasarkan pada buku “Clean Code: A Handbook of Agile Software Craftsmanship” oleh Robert Cecil Martin, yang juga dikenal sebagai Uncle Bob Martin.

Prinsip-prinsip CLEAN CODE dapat diterapkan dalam berbagai bahasa pemrograman, termasuk PHP.

Prinsip CLEAN CODE dalam PHP

1. Mengikuti Standar Kode: Standar kode membantu memastikan bahwa kode konsisten dan mudah dibaca.
Standar kode umum yang digunakan dalam PHP adalah PSR-2, yang mencakup hal-hal seperti indentasi, spasi, dan konvensi penamaan.
Mengikuti standar ini dapat membantu memastikan bahwa kode Anda mudah dibaca dan dipahami oleh orang lain.

Contoh:

  class MyClass {
      private $myProperty;
      public function myFunction() {
          // ...
      }
  }

2. Menulis Tes yang Bersih: Tes adalah bagian integral dari pengembangan kode CLEAN.
Tulis tes yang terorganisir, mudah dibaca, dan berfokus pada perilaku tertentu.
Ini dapat membantu memastikan bahwa kode Anda bekerja seperti yang diharapkan dan memudahkan proses debugging.

Contoh:

function testAdditionWithPositiveNumbers() {
    // Test logic for positive numbers
}
function testAdditionWithNegativeNumbers() {
    // Test logic for negative numbers
}

3. Indentasi dan Panjang Baris Kode: Anda harus menggunakan tab daripada spasi untuk membantu komputer menampilkan kode dengan cara yang paling fleksibel. Dalam hal panjang baris, satu baris kode harus berada di antara 75–85 karakter untuk membuat kode lebih mudah dibaca.

4. Refactoring: Refactoring adalah proses dalam pengembangan perangkat lunak di mana penyesuaian manual atau otomatis dilakukan untuk meningkatkan bagian kode yang kurang elegan. Tujuan dari refactoring adalah untuk menghasilkan kode sumber yang fungsinya tidak berubah, tetapi strukturalnya mudah dibaca dan digunakan.

5. Penggunaan UTF-8: Selalu gunakan UTF-8 saat menulis kode PHP untuk mendukung karakter non-ASCII dan memastikan kompatibilitas dengan sistem yang mendukung UTF-8.

6. Penerapan Template: Gunakan template untuk memisahkan struktur HTML dari logika PHP. Ini membuat kode lebih bersih dan mudah dipelihara.

Contoh:

<?php // user_profile.php ?>
<?php $this->layout('template', ['title' => 'User Profile']) ?>
<h1>User Profile</h1>
<p>Hello, <?=$this->escape($name)?></p>

Best Practices dan Tips

Berikut adalah beberapa best practices dan tips untuk menulis kode CLEAN dalam PHP:

1. Pendekatan Object-Oriented Programming (OOP): PHP memiliki fitur OOP yang lengkap, termasuk dukungan untuk kelas, kelas abstrak, antarmuka, pewarisan, konstruktor, kloning, pengecualian, dan lainnya. Menggunakan pendekatan OOP dapat membantu membuat kode Anda lebih mudah dipahami dan dipelihara.

2. Metode dan Fungsi Harus Pendek: Metode dan fungsi harus sepenuhnya fokus pada satu tugas. Jika metode atau fungsi Anda melakukan lebih dari satu tugas, pertimbangkan untuk memecahnya menjadi beberapa metode atau fungsi yang lebih kecil.

Contoh:

  class MyLogClassExample {
      protected $fileResource;
      protected $filename;
      public function __construct($filename)
      {
          $this->filename = $filename;
          $this->fileResource = fopen($filename, 'a+');```

*filename dan fileResource