PradoSoft

Konvensi Kode dan Petunjuk

From PRADO Wiki


Organisasi Direktori dan File

  • Keputusan untuk membuat direktori baru harus ditinjau ulang oleh manajer program.
  • Setiap kelas PHP harus ditulis dalam sebuah file yang namanya sama seperti nama kelas. File juga dapat berisi kelas yang hanya dipakai oleh kelas utama.

Konvensi Penamaan

  • Nama kelas harus dimulai dengan huruf 'T' diikuti oleh nama dalam huruf besar kecil (misalnya TTextBox). Untuk menghindari konflik nama di dalam kerangka kerja, pilih dengan bijaksana nama kelas. Hindari penggunaan nama yang terlalu umum, seperti misalnya TParameter.
  • Nama antarmuka harus dimulai dengan huruf 'I' diikuti dengan nama dalam huruf besar kecil (misalnya IPostBackControl).
  • Nama properti mengikuti konvensi huruf besar kecil, misalnya kata adalah digabungkan tanpa spasi, dan setiap kata dikapitalkan di dalam gabungan. Sebagai contoh, BorderWidth dan FontName semuanya benar, sementara border_width dan fontname tidak dipakai.
  • Nama event juga mengikuti konvensi huruf besar kecil dengan persyaratan tambahwan yaitu kata pertama harus On. Sebagai contoh, OnClick, OnPageIndexChanged semuanya benar.
  • Nama fungsi dan variabel mirip dengan nama properti, kecuali kata pertama tidak dikapitalkan (misalnya authenticateUser(), $wordCount).
  • Nama anggota kelas private, silahkan awali dengan sebuah karakter garis bawah agar dapat dibedakan dengan mudah dari variabel lainnya yang bisa diturunkan.
  • Nama konstan harus semuanya dibesarkan dan kata-kata di dalamnya disatukan dengan garis bawah (misalnya TEXT_ALIGNMENT)
  • String pesan eksepsi harus dalam bentuk classname_noun_reason, di mana classname merujuk ke nama kelas (tanpa 'T') yang dimunculkan eksepsi, noun menjelaskan subyek terkait dengan kesalahan, dan reason biasanya sebuah kata keterangan yang menjelaskan kesalahan. Karakter dalam pesan harus dalam huruf kecil. Sebagai contoh, control_id_invalid direkomendasikan.

Praktek Direkomendasikan

  • Hindari mendefinisikan variabel global dan konstant. Lebih baik, definisikan kelas static dan konstan kelas.
  • Hindari penggunaan properti secara langsung. Gunakan metode pengambil dan penyetel terkait. Sebagai contoh, $this->getText() direkomendasikan, sementara $this->Text tidak.
  • Gunakan Prado::using(Path.To.Class) untuk menyertakan file kelas, daripada include_once() atau require_once().
  • Ketika memodifikasi file yang sudah ada, coba untuk mengikuti gaya pengodean yang sudah ada agar file terlihat konsisten bentuknya.
  • Gunakan varabel anggota kelas private daripada protected atau public. Tulis metode pengakses untuk memberikan akses ke variabel anggota.

Trik PHP Yang Harus Anda Ketahui

  • === lebih baik daripada == karena == akan melakukan konvensi tipe
  • $var===null lebih baik daripada is_null($var)
  • $str!== lebih baik daripada strlen($str)
  • ++$i lebih baik daripada $i++
  • for($i=0, $k=count($j); $i<$k; ++$i) lebih baik daripada for($i=0; $i<count($j); ++$i)
  • ctype_digit($foo) lebih baik daripada preg_match("![0-9]+!", $foo)
  • if(isset($array['key'])) lebih baik daripada if(in_array('key', $keys))
  • if(!isset($foo{5})) lebih baik daripada if(strlen($foo) < 5)
  • echo lebih baik daripada print
  • true lebih baik daripada TRUE
  • false lebih baik daripada FALSE
  • null lebih baik daripada NULL

Lebih rinci dapat ditemukan dalam Trik Optimasi PHP dan Mengoptimasi Naskah PHP.

Personal tools
Your user name:

Your password:

MediaWiki