Hal-hal yang Perlu Diperhatikan di PSR-2

Halo teman-teman, buat kamu yang menggunakan Laravel 11, Kamu harus tau nih standarisasi untuk menulis koding, supaya kodinganmu terlihat konsisten dan mudah dibaca, kebetulan untuk Laravel 11 memiliki gaya penulisan kode dengan pendekatan PSR-2, atau Coding Style Guide, adalah standar yang dirancang untuk memastikan konsistensi dan keterbacaan kode PHP. Mengikuti PSR-2 tidak hanya membuat kode lebih bersih dan terstruktur tetapi juga memudahkan kolaborasi tim. Berikut adalah beberapa hal penting yang perlu diperhatikan saat menerapkan PSR-2.

Indentasi dan Spasi

Indentasi

• Gunakan 4 spasi untuk setiap level indentasi. Hindari penggunaan tab untuk menjaga konsistensi di seluruh kode.

Baris Kosong

• Pisahkan blok kode dengan baris kosong, tetapi tidak lebih dari dua baris kosong berturut-turut. Ini membantu membagi kode menjadi bagian-bagian yang lebih mudah dibaca.

Penulisan Baris Kode

Panjang Baris

• Batasi panjang baris kode hingga 120 karakter. Jika baris melebihi panjang ini, pecah menjadi beberapa baris untuk meningkatkan keterbacaan.

Baris Kosong

• Gunakan satu baris kosong setelah deklarasi namespace dan sebelum deklarasi use. Ini membantu memisahkan bagian-bagian kode yang berbeda secara jelas.

Penulisan Kode

Kurung Kunci

• Setiap blok kode harus memiliki kurung kurawal ({}) pada baris yang sama dengan pernyataan yang memulai blok. Kurung kurawal penutup harus berada pada baris baru.

Return, Break, Continue

• Tulis return, break, dan continue pada baris baru setelah kurung kurawal penutup untuk memastikan kode mudah dibaca dan dipahami.

Penamaan

Nama Kelas

• Gunakan PascalCase untuk nama kelas, di mana setiap kata dimulai dengan huruf kapital.

Nama Metode dan Fungsi

• Gunakan camelCase untuk nama metode dan fungsi, di mana kata pertama dimulai dengan huruf kecil dan kata-kata berikutnya dimulai dengan huruf kapital.

Nama Variabel

• Gunakan camelCase untuk nama variabel, menjaga konsistensi dengan penamaan metode dan fungsi.

Pemisahan dan Penulisan

Namespace dan Use

• Tempatkan deklarasi namespace dan use di bagian atas file sebelum kode lainnya. Gunakan satu baris kosong setelah deklarasi ini untuk memisahkan dari kode yang mengikuti.

Komentar

Komentar Satu Baris

• Gunakan // untuk komentar singkat. Tempatkan komentar pada baris yang sama dengan kode, dipisahkan oleh satu spasi untuk menjelaskan fungsi kode.

Komentar Blok

• Gunakan /* ... */ untuk komentar yang lebih panjang atau blok kode. Ini membantu memberikan penjelasan lebih mendetail tentang bagian-bagian kode yang kompleks.

Array

Sintaks Array

• Gunakan sintaks array pendek ([]) alih-alih array(). Ini adalah gaya penulisan yang lebih modern dan lebih bersih.

Elemen Array

• Letakkan setiap elemen array pada baris baru jika array tersebut panjang. Ini membantu menjaga keterbacaan dan memudahkan pemahaman struktur array.

Tipe Data dan Fungsionalitas

Deklarasi Tipe Data

• Gunakan deklarasi tipe data untuk parameter dan return type jika PHP versi yang digunakan mendukungnya (PHP 7.0 ke atas). Ini membantu memastikan bahwa data yang diproses sesuai dengan tipe yang diharapkan.

Penanganan Kesalahan

Mekanisme Penanganan Kesalahan

• Gunakan mekanisme penanganan kesalahan PHP yang sesuai seperti try-catch. Hindari penanganan kesalahan dengan kode yang tidak perlu untuk menjaga kebersihan dan keterbacaan kode.

Kesimpulan

Mengikuti PSR-2 dapat meningkatkan kualitas kode PHP dengan memastikan konsistensi dan keterbacaan. Dengan memperhatikan pedoman ini, kamu dapat membuat kode yang lebih terstruktur, mudah dipahami, dan mudah dikelola, terutama dalam proyek yang melibatkan banyak pengembang.