Coding Best Practise

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

4 && $r<4 || $p=3)
x('param_lagi');
}
?>
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

/**
 * Keteangan tentang kelas
 *
 * @category   Nama kategori
 * @package    Nama Paket
 * @author      pembuat code 
 * @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

Tags: ,

5 Responses to “Coding Best Practise”

  1. PendekarKodokBLOG May 22, 2009 at 11:12 pm #

    Nu.. Link Blog aku nu..
    Punya mu udah aku Link..

    “Dalfi”

    • admin May 23, 2009 at 1:14 pm #

      Udah kk.. udah saya link kan :D

  2. Tania May 23, 2009 at 1:53 pm #

    webwoorks.net – da best. Keep it going!
    Thank you
    Tania

  3. ibnoe May 25, 2009 at 9:59 pm #

    @tania : thanks

  4. harga blackberry torch October 27, 2011 at 4:44 am #

    Makasih Boss.. Infonya mantap

Leave a Reply