PHP DOC

Setelah membuat sebuah program kadang kita membutuhkan dokomentasi dari source code yang kita bikin, baik untuk keperluan sendiri atau untuk programmer lain, agar lebih mudah di mengerti dari source code yang kita buat.

untuk membuat dokomentasi source code PHP, kita bisa memanfaatkan yang telah di buat oleh www.phpdoc.org

berikut ini cara instalasi phpdoc pada system operasi hardy heron

1. install php-pear (bila di belum terisntall pear)
sudo apt-get install php-pear

2. install phpdoc dengan menggunakan pear
sudo pear install PhpDocumentor

3. periksa hasil instalasi dengan mengekitkan phpdoc


berikut ini contoh menggunakan phpdoc

$ phpdoc -o HTML:frames:earthli -f sample1.php -t docs  
phpdoc = perintah untuk menjalankan phpdoc
-o = format yang digunakan untuk membuat phpdoc
-f = file PHP yang akan dibuatkan dokumentasinya
-t = alamat untuk menyimpan hasil dokumentasi


screen shoot hasil php dokumentasi dengan contoh sebuah class

untuk mengetahui lebih detail tentang tata cara penulisan dalam membuat dokomentasi source code, silakan klk link tutorial