Rapikan Cuplikan PHP

Mengapa format membantu pembaca

Orang memindai kode dari bentuknya. Ketika kurung kurawal sejajar dan setiap pernyataan punya baris sendiri, pembaca melihat strukturnya sebelum membaca satu kata pun. Peninjau dapat langsung melihat kurung kurawal yang hilang atau perulangan yang berada di tempat yang salah. Teks datar menyembunyikan semua itu.

Sebelum dan sesudah

Asli, disalin dari log:

<?php function total($items){$sum=0;foreach($items as $item){$sum+=$item["price"];}return $sum;}

Dirapikan dengan 4 spasi:

<?php function total($items)
{
    $sum=0;
    foreach($items as $item)
    {
        $sum+=$item["price"];
    }
    return $sum;
}

Daftar periksa singkat sebelum memposting

• Hapus rahasia. Teks yang Anda tempel di sini diproses di server kami, jadi jangan gunakan kredensial asli, token, atau data pelanggan.
• Jaga contohnya tetap minimal, hanya dengan baris yang diperlukan untuk menunjukkan masalahnya.
• Sebutkan versi PHP yang Anda gunakan dan hasil yang Anda harapkan.
• Bandingkan kode yang sudah diformat dengan aslinya. Alat ini hanya mengubah tata letak, tetapi komentar dan string bisa terpengaruh aturan spasi.
• Letakkan hasilnya di dalam blok kode agar indentasinya tetap terjaga.

Yang tidak dilakukan alat ini

Alat ini tidak menemukan kesalahan, tidak menjalankan kode Anda, dan tidak memeriksa aturan gaya. Tata letak yang rapi memudahkan Anda melihat masalah, tetapi tidak memperbaikinya.

Di mana ini membantu

• Tiket dukungan atau laporan bug yang menyertakan contoh kode.
• Pertanyaan di forum pengembang atau kanal obrolan.
• Halaman dokumentasi atau tutorial yang contohnya perlu tampil rapi.
• Komentar tinjauan saat Anda menyarankan perubahan pada sebagian fungsi.

Dalam setiap kasus, pembaca melihat strukturnya dulu lalu masalahnya, dan itulah urutan yang Anda inginkan.

Jaga agar contoh tetap jujur

Format kode yang benar-benar akan Anda posting, bukan versi tulis ulang yang lebih bersih. Jika Anda memendekkan nama variabel atau menghapus baris agar contohnya muat, jalankan dulu versi yang dipendekkan itu sendiri. Cuplikan yang rapi tetapi tidak mereproduksi masalah hanya membuang waktu pembaca. Jika Anda menambahkan catatan tentang hasil yang Anda harapkan, tulis dengan kalimat biasa di atas blok kode.