Coding Best Practise adalah cara-cara coding yang efektif dan telah teruji oleh para-para ahli dan praktisi koding. Jika ingin mendapatkan hasil code yang baik maka kita sebaiknya mengikuti standar-standar berikut ini
1. Coding standar
Coding standar artinya kita harus mempunyai ketetapan-ketetapan dalam menulis code. Misal penamanaan kelas, fungsi, spacing, tab, dll. Tujuannya adalah membuat kode kita gampang dibaca dan gampang di maintain. Ada beberapa coding standar yang dapat kita gunakan diantaranya:
- Pear PHP Coding Standar http://pear.php.net/manual/en/standards.php
- Zend Coding Standar http://framework.zend.com/manual/en/coding-standard.html
Contoh Kode yang buruk
1 2 3 4 5 6 7 8 | <?php //fungsi 1 if ($syarat){ fungsi1($param_a); if($a>4 && $r<4 || $p=3) x('param_lagi'); } ?> |
1 2 3 4 5 6 7 8 9 10 | <?php //mengambil nilai siswa if ($is_siswa) { display_siswa_info($id_siswa); if( ($a>4) && ($r<4) || ($p=3)) simpan_data_siswa($data_siswa); } ?> |
2. Code Commenting
Code commenting adalah sebuah aktifitas memberikan komentar pada kode yang telah kita buat. manfaat yang diperoleh adalah mempermudah kita dalam membaca kode, bisa berfungsi sebagai dokumentasi.
Contoh komentar yang mengikuti standar phpdocumentor
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 | /** * Keteangan tentang kelas * * @category Nama kategori * @package Nama Paket * @author pembuat code <[email protected]> * @copyright 1997-2005 The PHP Group * @license http://www.php.net/license/3_0.txt PHP License 3.0 * @version Release: @package_version@ */ class Foo_Bar_Baz { /** * keterangan tentang variabel * * @var string */ public $foo = 'unknown'; /** * keterangan singkat tentang fungsi * * @param string $arg1 argumen pertama, bertipe string * @param int $arg2 argumen kedua bertipe integer. * @return int Hasil kembalian fungsi ini * */ public function fooBar($arg1, $arg2='') { // code... return 1; } } |
3. Code Reuse
Code reuse ini bermaksud untuk menggunakan kembali kode-kode yang sudah pernah kita buat di project sebelumnya. Kadang-kadang kita harus melakukan refaktoring pada kode yang telah kita buat. gunakanlah konsep DRY (dont repeat yourself).
4. Code Testing
ketika kita membuat code. biasakan untuk mengetes kode tersebut. kita juga dapat menggunakan unit test untuk menguji kode kita ini.
5. Source Control
Source control dapat berfungsi sebagai personal undo, tool kolaborasi kode jika kita bekerja di team. Inti penggunaan source control adalah melakukan tracking terhadap kode yang telah kita buat
6. Code Quality Improvement
code yang kita buat harus
- simple : Solusi yang ditawarkan harus menggunakan algoritma yang paling simple (KISS – Keep it simple stupid)
- menyelesaikan masalah : percuma jika kode yang kita buat tidak menyelesaikan masalah
- secure : kode yang kita buat harus aman
- maintainable : kode yang kita buat harus dapat di maintain/ di ubah dengan mudah
- scalable : : kode yang kita buat harus scalable, tidak peduli jumlah data yang banyak, performa tetap stabil
Nu.. Link Blog aku nu..
Punya mu udah aku Link..
"Dalfi"
Udah kk.. udah saya link kan :D
webwoorks.net - da best. Keep it going!
Thank you
Tania
@tania : thanks
Makasih Boss.. Infonya mantap