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