Panduan Menulis Kode PHP dengan Baik dan Benar

Panduan Menulis Kode PHP dengan Baik dan Benar. Mungkin ini terdengar sepele bagi kalian tapi mungkin tidak bagi temen-temen yang sudah berkecimpung di dunia perkodean selama bertahun-tahun apalagi mereka yang bekerja dalam bentuk tim.  di dalam sebuah tim diperlukan sebuah aturan atau kesepakatan salah satunya adalah penulisan kode. Meskipun onphpid sendiri masih berkeyakinan bahwa aturan menulis kode php ini bukan sesuatu yang baku artinya bisa disesuaikan dengan kondisi atau mengikuti aturan di dalam tim atau perusahaan sehingga menjadi senjata rahasia dari sebuah tim atau perusahaan tersebut.

Kenapa Aturan Penulisan Kode PHP itu Penting?

Karena bagaimana cara kita menulis kode php bisa mempengaruhi kemungkinan suatu web aplikasi sudah kita tulis dapat dikembangkan lagi atau harus dibuang…
Biar lebih ngeh dengan apa yang onphpid  maksudkan, mari kita bandingkan saja kedua kode dibawah  ini :

itu baru sebagain selengkapnya bisa di lihat disini.

Lalu Kode PHP yang kedua:

inipun baru sebagian selengkapnya bisa dilihat disini.

Nah, bagaimana?

Onphpid yakin untuk kode yang pertama 1-3 minggu tidak kita buka atau kita tinggalkan pasti ketika  kita buka kembali kita akan kebingungan dan bertanya ini kode apa? Atau ini cara kerjanya kemarin bagaimana ya?
Nah, jika kita yang buatnya saja bisa kebingungan, bagaimana dengan teman kita yang tidak tau sama sekali logika dan rencana program kita ini seperti apa lalu kemudian kita minta dia untuk mengembangkannya?

Maka solusi yang paling tepat adalah membacanya dari awal atau membuangnya dan membuat yang baru.

Ok.. onphpid pernah mengalami ini dan untungnya teman onphpid ini baik,  saking baiknya  cacian dan makianlah  yang diberikan kepada onphpid dapatkan waktu itu… “kode jeleklah, kode tidak rapilah dan bla bla bla”

ya dan itu lebih baik dari pada “maaf gan ane lagi sibuk” atau “maaf gan ane gak biasa baca kode orang”…

yang intinya mereka tidak mau membaca kode yang sudah capek-capek kita buat.

Setelah teman onphpid ini  selesai mencaci dan memaki barulah dia dengan baik hati mengajarkan Coding style (gaya berkode) dengan menunjukan PSR (PHP Standards Recommendation) yang memungkinkan bisa bekerja sama dengan banyak orang.

APA ITU PSR?

PSR atau PHP Standars Recommendation hanya sebuah label dari sebuah group yang bernama FIG (Framework Interoperability Group) mereka sebuah group yang secara tidak langsung ikut dalam pengembangan berbagai Framework yang berdasarkan voting dari para member.

Tujuan dari FIG sendiri adalah untuk membuat standar penulisan progam sehingga para developer memiliki Gaya berkoding yang sama.

Pada saat artikel ini onphpid tulis FIG telah menulis PSR yang dimulai dari 1, 2, 3, 4, 6, 7.

  1. PSR-1 : Basic Coding Standard
  2. PSR-2 : Coding Style Guide
  3. PSR-3 : Logger Interface
  4. PSR-4 : Autoloading Standard
  5. PSR-6 : Caching Interface
  6. PSR-7 : HTTP Message Interface

Meski sudah ada 6 list diatas kita hanya akan membahas PSR-1 dan PSR-2 saja sebagai dasar kita bercoding.

PSR 1 : Basic Coding Standard

Sebagai Dasar Pengkodean Standar pada PSR 1 terdapat beberapa aturan sebagai berikut:

  1. File HARUS menggunakan Tags PHP <?php ?> atau <?= ?> saja.
    jangan Menggunakan variasi tag yang lain.
  2. File hanya menggunakan UTF-8 dan tidak menggunakan BOM (byte-order mark).
  3. File harus mendeklarasikan (menjelaskan) Class, functions, constantas dan lain-lain atau menjelaskan hasil outputnya atau pengaruhnya terhadap aplikasi yang dibangun dan tidak disarankan mencampur keduanya dalam satu file. Maksudnya adalah file berisi class sendiri, berisi functions sendiri, berisi include/require sendiri, berisi print/echo sendiri atau berisi suatu logic juga sendiri.
  4. Penamaan Class HARUS menggunakan StudlyCaps.
    StudlyCaps adalah format penulisan yang huruf kapital dan huruf kecil tidak beraturan seperti STudlycApS, stuDLYCapS
  5. Penamaan Constanta HARUS menggunakan huruf kapital dan garis bawah sebagai pengganti spasi.
  6. Penamaan Method HARUS dengan cemalCase.
    cemalCase adalah format penulisan tanpa sepasi sebagai pemisah (jika lebih dari 1 kata) diganti dengan mengubah setiap huruf awal dalam kata menjadi kapital CamelCase, PowerPoint, WordPress.

Biar lebih mudah langsung ke contoh aja…

Penamaan Class HARUS menggunakan StudlyCaps

Penamaan Constanta

Penamaan Method

PSR-2: Coding Style Guide

Pada PSR yang kedua ini kita lebih difokuskan pada kerapian kode sehingga mudah dibaca baik oleh diri kita sendiri atau orang lain.

  1. Mengikuti Aturan coding php PSR-1.
  2. indent (penulisan yang menjorok kedalam layaknya paragraf) menggunakan 4 (empat) spasi bukan Tab.
  3. Menulis kode jangan telalu panjang. usahakan batas maksimal sekitar 120 karakter atau lebih baik kurang dari 80 karakter.
  4. Memberi garis baru (blank line) setelah mendeklarasikan namespace atau use (atau banyak use).
  5. Penulisan Kurung buka “{” pada sebuah Classes dan Methods HARUS diberi garis baru (new line) dan  kurung tutup “}” juga diberikan satu garis baru.
  6. Visibility (private, protected, public) HARUS ke semua Propertis dan method, abstract dan final HARUS dideklarasikan sebelum Visibility, dan static HARUS dideklarasikan sesudah Visibility.
  7. Control Structure Keyword HARUS diberi spasi sebelum kurung buka “{“.
  8. Kurung Buka “{” untuk Control Structure ditulis pada garis yang sama dan untuk penutup “}” ditulis disetelah body.
  9. Setiap Arguments pada method HARUS diberi satu spasi setelah koma dan argumen yang memiliki nilai default SEBAIKNYA ditaruh di deret paling belakang.

Oke langsung saja kecontoh lagi…

Dekalarsi Namespace dan Use

Penulisan Class dan Method dan kondisi kode yang terlalu panjang

Penulisan Visibility

Control Structure

If,  elseif,  else

Switch Case

while dan do while

for dan foreach

try and catch

Kurang Lebih itu yang bisa onphpid share kepada kalian tentang aturan menulis kode php agar kode kita bisa dibaca oleh orang lain dan jangan lupa untuk menambahkan komentar atau note pada kode yang kita buat agar lebih mudah dipahami maksud dan tujuan dari kode tersebut.

Sekian apabila ada pertanyaan atau koreksi bisa memanfaatkan kolom komentar dibawah ini.

Sumber Referensi:

http://www.php-fig.org

https://www.w3.org/International/questions/qa-byte-order-mark.en

http://pear.php.net/manual/en/standards.sample.php

http://php.net/manual/en/language.control-structures.php

Cara Membuat WordPress Menjadi Lebih Unik dan Menarik
Mematikan Notifikasi Update Theme WordPress

  • Herlina Pangastuti

    apik biji sejuta