PHP - Piawai Coding

Selamat sejahtera, pembangun PHP masa depan! Saya begitu gembira untuk memandu anda melalui dunia yang menarik piawai coding PHP. Sebagai seseorang yang telah mengajar pengaturcaraan selama tahun, saya dapat memberikan jaminan bahawa memahami piawai ini akan membuat kod anda lebih bersih, mudah baca, dan lebih profesional. Mari kita masuk ke dalam!

Indentasi dan Panjang Baris

Indentasi yang betul adalah seperti adab baik dalam pengaturcaraan - ia membuat segalanya lebih menyenangkan dan mudah difahami. Dalam PHP, kita biasanya menggunakan 4 ruang untuk setiap aras indentasi. Berikut adalah contoh:

<?php
if ($condition) {
echo "This line is indented";
if ($another_condition) {
echo "This line is indented even more";
}
}

Dalam contoh ini, pernyataan pertama echo diindent sekali (4 ruang), dan pernyataan kedua echo diindent dua kali (8 ruang). Hierarki visual ini membantu kita memahami struktur kod dengan cepat.

Bagi panjang baris, cuba untuk menjaga baris anda di bawah 80 aksara. Jika satu baris menjadi terlalu panjang, pecahkan ia kepada beberapa baris seperti ini:

$very_long_variable_name = $another_long_variable_name
+ $yet_another_long_variable_name
+ $one_more_long_variable_name;

Struktur Kawalan

Struktur kawalan adalah blok-blok yang membentuk logik program anda. Dalam PHP, yang paling biasa adalah if, else, elseif, while, for, dan switch. Berikut adalah bagaimana untuk memformat mereka dengan betul:

if ($condition1) {
// kod di sini
} elseif ($condition2) {
// lebih banyak kod di sini
} else {
// lebih banyak lagi kod di sini
}

while ($condition) {
// kod untuk diulangi
}

for ($i = 0; $i < 10; $i++) {
// kod untuk diulangi
}

switch ($variable) {
case 1:
// kod untuk kes 1
break;
case 2:
// kod untuk kes 2
break;
default:
// kod default
break;
}

Perhatikan bagaimana setiap blok kod diapit dalam kurungan {} dan diindent dengan betul.

Pemanggilan Fungsi

Bila memanggil fungsi, tidak ada ruang antara nama fungsi dan buka kurungan. Berikut adalah cara yang betul:

$result = myFunction($arg1, $arg2);

Jika pemanggilan fungsi terlalu panjang, anda boleh pecahkan ia kepada beberapa baris:

$result = myVeryLongFunctionName(
$arg1,
$arg2,
$arg3,
$arg4
);

Definisi Fungsi

Bila mendefinisikan fungsi, ikuti format ini:

function myFunction($arg1, $arg2 = null)
{
// badan fungsi
}

Perhatikan bahawa kurungan buka { di atas baris baru. Ini dipanggil " gaya Allman" dan umum digunakan dalam PHP.

Komen

Komen adalah penting untuk menjelaskan kod anda. Gunakan mereka dengan separa! Berikut adalah jenis-jenis komen dalam PHP:

// Ini adalah komen baris tunggal

/*
Ini adalah komen multi-baris.
Ia boleh melintasi beberapa baris.
*/

/**
* Ini adalah komen DocBlock.
* Ia digunakan untuk mendokumentasikan fungsi, kelas, dll.
*
* @param string $arg1 Deskripsi argumen pertama
* @return bool Deskripsi apa yang dikembalikan fungsi
*/
function myDocumentedFunction($arg1)
{
// badan fungsi
}

Tag Kod PHP

Bila menulis kod PHP, selalu gunakan tag PHP penuh:

<?php
// Kod PHP anda di sini
?>

Hindari penggunaan tag pendek seperti <? kerana mereka tidak selalu diaktifkan di semua server.

Nama Variabel

Nama variabel seharusnya deskriptif dan menggunakan huruf kecil dengan tanda underscore (snake_case):

$user_name = "John";
$total_items = 5;

Untuk konstant, gunakan huruf besar dengan tanda underscore:

define('MAX_USERS', 100);

Buat Fungsi Reentrant

Fungsi reentrant adalah yang boleh dihentikan di tengah eksekusinya dan kemudiannya dipanggil lagi dengan selamat. Untuk mencapai ini, hindari penggunaan variabel global atau variabel statik dalam fungsi anda. Berikut adalah contoh:

// Tidak reentrant
function badCounter()
{
static $count = 0;
return ++$count;
}

// Reentrant
function goodCounter($count)
{
return ++$count;
}

Penyelarasan Blok Penyataan

Bila menyatakan beberapa variabel, selaraskan mereka untuk kelegaan membaca:

$short        = 1;
$long_variable = 2;
$longer_variable = 3;

Satu Pernyataan Per Baris

Untuk kejelasan, letakkan hanya satu pernyataan per baris:

$a = 1;
$b = 2;
$c = 3;

Hindari:

$a = 1; $b = 2; $c = 3; // Ini lebih sukar dibaca

Metode atau Fungsi Pendek

Jaga fungsi anda pendek dan fokuskan kepada tugas tunggal. Sebagai panduan, jika fungsi lebih panjang daripada 20-30 baris, pertimbangkan untuk pecahkan ia kepada fungsi yang lebih kecil.

Berikut adalah jadual yang menggabungkan beberapa piawai coding PHP yang telah kita diskusikan:

Piawai	Contoh
Indentasi	Gunakan 4 ruang
Panjang Baris	Jaga di bawah 80 aksara
Pemanggilan Fungsi	myFunction($arg1, $arg2);
Definisi Fungsi	function myFunction($arg1, $arg2) { ... }
Nama Variabel	Gunakan snake_case: $user_name
Konstant	Gunakan UPPER_CASE: MAX_USERS
Komen	Gunakan //, /* */, atau /** */
Tag PHP	Selalu gunakan <?php ?>

Ingat, piawai ini bukan sahaja aturan sembarang. Mereka adalah amalan terbaik yang dikembangkan selama tahun oleh komuniti PHP untuk membuat kod lebih mudah dibaca dan dipelihara. Dengan mengikuti piawai ini, anda tidak hanya menulis kod - anda juga berkomunikasi dengan pembangun lain yang mungkin bekerja pada kod anda di masa depan. Dan siapa tahu? Pembangun masa depan itu mungkin anda sendiri!

Sementara kita bersama, saya diingatkan oleh seorang pelajar yang pernah berkata kepad saya, "Mempelajari piawai coding adalah seperti mempelajari adab makan. Ia tampak keras pada permulaan, tetapi selepas anda bias, anda bertanya-tanya bagaimana anda pernah hidup tanpa itu!" Jadi, teruskan untuk mempraktikkan piawai ini, dan mereka akan menjadi tabiat kedua anda. Selamat coding!

Credits: Image by storyset