AKU BUKAN PUJANGGA “PROF”

CODING BEST PRACTISE by aha 2013

Koding : Masa Lalu & Kini

Pada Jaman Dulu Kala 1 candi 1 pujangga

1 pujangga makin pintar, ditambahi 2,3-1000 candi

Zaman Berlalu Pujangga baru dapat warisan beberapa candi

Dosa pujangga lama : lupa dan malas buat dokumentasi karena candinya banyak

Pujangga baru bingung, pujangga lama linglung

Tujuan

Memahami cara penulisan koding (Best Practise) dengan cara

Konsistensi

Hindari

Dokumentasi

Menjadi Programmer Profesional yang mempunyai nilai tambah dengan kemampuan dokumentasi yang memadai

Konsistensi - indentasi

Indentasi

Style 1 Style 2 Style 3

Konsistensi - Penamaan

Penamaan File, Class, Function, Variabel

Bila lebih dari 2 kata, file ditulis dengan underscore sebagai penghubung

Umumnya penulisan class, function atau method menggunakan style :

camelCase : huruf kapital ditiap kata kecuali kata pertama

underscore

Konsistensi - Variabel

Penulisan variabel temporer:•$i, $j, $n untuk looping counter•$k dan $v untuk foreach•$q, $r, $d untuk mysql•$fp untuk file pointer•$ret, $data untuk variabel return

Konsistensi – Code Grouping

Pengelompokan Kode

Konsistensi - SQL

Kode SQL ditulis dalam huruf kapital

Hindari – Obvius Comment

Penulisan komen yang membingungkan

Hindari – Nested IF

IF yang bersarang

Hindari – Long Teks

Penulisan memanjang dalam 1 baris

Dokumentasi - phpDoc

Penulisan dokumentasi dengan bantuan phpDocumentor

PhpDocumentor 2 adalah versi terbaru

Istilah DocBlock digunakan phpDoc untuk mem-parsing comment code menjadi teks dokumentasi

Dokumentasi - DocBlock

DocBlock terdiri dari 3 bagian Short Description

Ditulis pada baris pertama komen dan diakhiri dengan titik atau baris kosong

Long Description

Ditulis lebih panjang dalam beberapa baris dan bisa berisi kode html

Tag

Ditulis dengan awalan @ dengan satu kata yang telah didefinisikan oleh phpDoc

Dokumentasi – Tag Definition

Pola penulisan Tag

@var [type]

@param [type] [$varname] [description]

@return [type] [description]

@author [nama kodinger]

@access [public/private]

@package [nama paket]

@subpackage [nama subpaket]

Dokumentasi

Contoh pada function

Dokumentasi

Contoh pada file

Dokumentasi - Generator

Menciptakan file dokumen dengan perintah

php phpdoc –d [direktori asal] –t [direktori target] –title [judul dokumen]

atau gunakan docBuilder dari http://sourceforge.net/projects/phpdocu/

Contoh hasil dari generator phpDoc

Dokumentasi - Cool

Studi Kasus

Pembuatan dokumentasi untuk katalog gramedia

Menentukan file-file yang akan di dokumentasi

Menentukan folder untuk dokumentasi

Menentukan judul dokumentasi dan pengaturan bentuk dokumentasi

Manfaat

Untuk pemakai Eclipse, Aptana, IDE lain

Manfaat – Code Completion

Referensi

http://www.phpdoc.org

http://phpdocu.sourceforge.net/howto.php

http://files.zend.com/help/previous-version/Zend-Studio-8/creating_a_phpdoc.htm

http://www.speich.net/articles/2010/05/08/integration-of-phpdocumentor-into-eclipse-or-aptana/

http://sourceforge.net/projects/phpdocu/

Good Luck

“Any fool can write code that a computer can understand. Good programmers write code that humans can understand. ”

Martin Fowler

Semoga Rekan-rekan menjadi Pujangga “Prof”