Dokumen ini membahas tentang pentingnya praktik terbaik dalam penulisan kode (coding best practice) seperti konsistensi, dokumentasi, dan hal-hal yang harus dihindari. Tujuannya adalah agar para programmer menjadi profesional dengan kemampuan dokumentasi yang memadai. Beberapa poin kuncinya adalah pentingnya indentasi dan penamaan yang konsisten, menghindari komentar yang tidak berguna, dan menggunakan phpDoc untuk mendokumentasikan fun

1. AKU BUKAN PUJANGGA “PROF”
CODING BEST PRACTISE by aha 2013

2. 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

3. Tujuan
 Memahami cara penulisan koding (Best
Practise) dengan cara
 Konsistensi
 Hindari
 Dokumentasi
 Menjadi Programmer Profesional yang
mempunyai nilai tambah dengan
kemampuan dokumentasi yang memadai

4. Konsistensi - indentasi
 Indentasi
Style 1 Style 2 Style 3

5. 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

6. 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

7. Konsistensi – Code Grouping
 Pengelompokan Kode

8. Konsistensi - SQL
 Kode SQL ditulis dalam huruf kapital

9. Hindari – Obvius Comment
 Penulisan komen yang membingungkan

10. Hindari – Nested IF
 IF yang bersarang

11. Hindari – Long Teks
 Penulisan memanjang dalam 1 baris

12. Dokumentasi - phpDoc
 Penulisan dokumentasi dengan bantuan
phpDocumentor
 PhpDocumentor 2 adalah versi terbaru
 Istilah DocBlock digunakan phpDoc untuk
mem-parsing comment code menjadi teks
dokumentasi

13. 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

14. Dokumentasi – Tag Definition
 Pola penulisanTag
 @var [type]
 @param [type] [$varname] [description]
 @return [type] [description]
 @author [nama kodinger]
 @access [public/private]
 @package [nama paket]
 @subpackage [nama subpaket]

15. Dokumentasi
 Contoh pada function

16. Dokumentasi
 Contoh pada file

17. 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

18. Dokumentasi - Cool

19. 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

20. Manfaat
 Untuk pemakai Eclipse, Aptana, IDE lain

21. Manfaat – Code Completion

22. 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/int
egration-of-phpdocumentor-into-eclipse-or-
aptana/
 http://sourceforge.net/projects/phpdocu/

23. 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”