Membuat Dokumentasi Kelas PHP dengan Netbeans + ApiGen/PhpDocumentor

Sistem Informasi adalah suatu kebutuhan yang sulit untuk dihindari dewasa ini, sejalan dengan perkembangan teknologi dan informai yang begitu pesatnya. Sistem Informasi tidak akan ada apabila tidak ada orang di belakang meja yang selalu melakukan pengembangan dan penyempurnaan SI tersebut, yaitu para programmer. Apa yang ditulis oleh programmer hanya dapat dipahami oleh programmer itu sendiri, bahkan programmer yang membuatnya pun terkadang kesulitan membaca ulang kode yang sudah dibuatnya. Hal itu terjadi akibat tidak adanya dokumentasi (dalam bentuk komentar) pada saat membuat program.

Dewasa ini, perkembangan perangkat bantu pemrograman juga berkembang dengan pesat. Sekarang sudah banyak tersedia editor yang pintar, seperti Netbeans. Ada banyak kemudahan (auto-xxx, seperti auto-comment, dll) yang ditawarkan, termasuk integrasi dengan documentation generator. Pada Netbeans (8.2) setidaknya terdapat 2 documentation generator, yaitu ApiGen dan PhpDocumentor.

WARNING!!

1. Lingkungan pemrograman yang berbasis UBUNTU 16.04 (turunan dari Debian), untuk Windows, Mac dan sistem operasi lainnya (atau Ubuntu versi selain itu) dapat disesuaikan
   
2. Netbeans yang digunakan adalah versi 8.2
   

Instalasi PHP

1. Pada Ubuntu 16.04, PHP yang didukung adalah PHP versi 7, sedangkan Netbeans versi 8.2 belum terlalu mendukung PHP versi 7. Oleh karena itu, perlu ditambahkan repositori yang terdapat PHP versi 5.6 yaitu dengan perintah
   sudo add-apt-repository ppa:ondrej/php
2. Install PHP versi 5.6 dengan perintah
   apt-get install php5.6 php5.6-dom php5.6-mbstring
   Catatan:
   php5.6-dom dibutuhkan oleh PhpDocumentor untuk error Class ‘DOMDocument’ not found in phar, sedangkan php5.6-mbstring dibutuhkan oleh ApiGen untuk error Call to undefined function ApiGen\Charset\Configuration\mb_list_encodings()
   

Instalasi Documentation Generator

1. ApiGen
   1. Unduh ApiGen dari alamat http://apigen.org/apigen.phar
   2. Pindah apigen.phar tersebut ke folder yang diinginkan, misal: /home/user/documentgenerator
2. PhpDocumentor
   1. Unduh PhpDocumentor dari alamat https://github.com/phpDocumentor/phpDocumentor2/releases/download/v2.9.0/phpDocumentor.phar
   2. Pindah phpDocumentor.phar tersebut ke folder yang diinginkan, misal: /home/user/documentgenerator

Setting Netbeans 8.2 dan Proyek PHP

1. Pastikan bahwa paket PHP telah diinstall
2. Buka pengaturan, klik menu Tools > Options
3. Pada jendela Options, piih tab PHP.
4. Pilih tab General, isi PHP 5 Interpreter dengan dimana php berada, untuk Ubuntu 16.04 berada di /usr/bin/php
5. Pilih tab Framework & Tools, Setting document generator:
   1. ApiGen
      Masukkan pada ApiGen Script: /home/user/documentgenerator/apigen.phar –debug
   2. PhpDocumentor
      Masukkan pada PhpDocumentor Script: /home/user/documentgenerator/phpDocumentor.phar
6. Klik Ok

Memilih Document Generator

Klik kanan pada proyek PHP, kemudian pilih Properties. Pada Categories pilih Documentation. Pada Document Provider pilih antara ApiGen atau PhpDocumentor. Isi Target Directory, yaitu lokasi dokumentasi akan dibuat. Untuk ApiGen bisa ditambah setting lain, seperti: charset, exclude dan access level.

Membuat Dokumentasi Pada Kode Program

1. Letakkan kursor di atas nama function atau class seperti pada gambar di bawah ini

   

2. Ketikkan /**, kemudian tekan enter seperti pada gambar di bawah ini
   dokumentasi 2
3. Isikan komentar untuk fungsi atau kelas tersebut seperti pada gambar di bawah ini

   

4. Berikut adalah contoh dari fungsi tanpa parameter, berparameter dan dengan nilai kembalian

   

Membuat Dokumentasi Dalam Bentuk Web

Klik kanan pada proyek PHP, kemudian pilih Generate Documentation