Welcome to Abdul Malik Ikhsan's Blog

PHPDocumentor : The Complete Documentation Solution for PHP

Posted in Teknologi, tips and tricks, Tutorial PHP by samsonasik on June 26, 2010

Menulis dokumentasi yang baik sangat penting bagi keberhasilan setiap proyek perangkat lunak. Kualitas dokumentasi bahkan bisa lebih penting daripada kualitas kode itu sendiri.  Kebanyakan programmer paling malas untuk membuat dokumentasi dengan alasan tidak mempunyai waktu yang cukup untuk membuat dokumentasi yang baik. Nah, apa yang terjadi ketika terjadi pengembangan perangkat lunak ? Programmer itu sendiri kesulitan untuk menerjemahkan kode programnya sendiri.   Nah, yang lebih jadi masalah apabila programmernya ganti. Kebayang ga apa yg akan terjadi ? He.he.he.he…

phpDocumentor dirancang untuk memudahkan untuk membuat dokumentasi.  Untuk menginstall phpDocumentor, pertama kita harus mempunyai PEAR , cara installnya silakan dibaca sendiri. Setelah itu kita run command :

pear install PhpDocumentor

Kalau sudah, kita buat deh simulasi contoh pembuatan dokumentasinya. Kita buat folder dan kita buat file-file php kita, contoh kita punya 2 file di satu folder, misal di D:\Zend\Apache2\htdocs\tutwordpress\testwillbedoc , dan kita beri nama WordPress1.php dan WordPress2.php. phpDocumentor mempunyai tag-tag yang berawalan dengan ‘@’ yang merupakan deskripsi program.

<?php
/**
 * This class is Parent of WordPress2
 * @author Abdul Malik Ikhsan
 * @filesource WordPress1.php
 * @version 1.0
 */
class WordPress1
{
 /**
 * a static variable
 * @static
 */
 public static $astaticvar = 0;

 /**
 * @todo initialize all func needed
 * @access public
 * @param String $param1
 * @param String $param2
 */
 public function WordPress1($param1,$param2)
 {
 //initialize all func needed
 }
}
?>

Kemudian file ke 2

<?php
/**
 * This class is Child of WordPress1
 * @author Abdul Malik Ikhsan
 * @filesource WordPress2.php
 * @version 1.0
 */

require_once 'Wordpress1.php';
class WordPress2 extends WordPress1
{
 /**
 * @todo initialize all func needed
 * @access public
 * @param String $param1
 * @param String $param2
 * @see WordPress1 Constructor
 */
 public function WordPress2($param1,$param2)
 {
 //initialize all func needed
 parent::Wordpress1($param1,$param2);
 }

 private function staticFunc()
 {

 }

 public function callerFunc()
 {

 }
}
?>

Kalau sudah, coba deh run di command line, seperti berikut :

phpdoc -o HTML:frames:phpedit -d D:\Zend\Apache2\htdocs\tutwordpress\testwillbedoc -s -t D:\Zend\Apache2\htdocs\tutwordpress\docs

Ok, kalau berhasil, maka akan terbentuk folder di D:\Zend\Apache2\htdocs\tutwordpress\ dan di dalamnya ada file-file HTML yang tergenerate seperti gambar berikut :

Nah, Coba kita klik file index.html-nya, maka akan tampil seperti berikut :

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

%d bloggers like this: