Comments on PHP
Pemberian komentar (c0mments) pada suatu source
code memberikan manfaat dalam memberikan keterangan dari suatu source code.
Kita dapat mencantumkan nama pengarang , judul dan keterangan lainnya dalam
suatu source cocde dari program yang dikembangkan. Penggunaan comments tidak
akan mempengaruhi source code. Dalam penulisan script PHP ,terdapat beberapa
macam gaya penulisan komentar.
Model
Single-Line C++ Syntax
Model penulisan komentar ini menggunakan teknik
penulisan yang dipinjam dari gaya penulisan pada program C++ yang ditandai
dengan // seperti contoh berikut:
<h4>Contoh KomentarSingle-Line
C++</h4>
<?php
// Title: Program Hello World
// Author: Pusat Ilmu Detil
echo "Hello World.";
?>
Model Shell
Syntax
Selain mendukung teknik penulisan comments
Single-Line C++, PHP juga mendukung teknik penulisan Single-Line pada Unix
shell yang disebut Shell Syntax dengan ditandai # seperti contoh berikut:
<h4>Contoh Komentar Shell
Syntax</h4>
<?php
# Title: Program Hello World
# Author: Pusat Ilmu Detil
echo "Hello World.";
?>
Model PhpDoc
- Bukalah Command Prompt : Open start ->run->cmd
- Masuk ke lokasi folder php pada XAMPP, dalam contoh ini asumsi XAMPP berada pada drive E. Instruksi adalah sebagai berikut:
- C:\>E:
- E:\>cd xampp\php
- E:\>xampp\php>pear config-set data_dir E:\xampp\htdocs\pear. Tunggu sampai keluar pesan "config-set succeeded".
- E:\>xampp\php>pear install PhpDocumentor. Pada proses ini akan mengdownload phpdoc, biarkan sampai selesai.
Setelah proses download selesai, langkah berikutnya aktifkan Apache
dan MySql server dan coba jalankan pada browser dengan mengetikkan:
Anda akan menemukan proses error pada config.php
baris ke 53 dan action.php baris ke-36. Untuk proses perbaikan error
tersebut,ikuti langkah berikutnya.
Carilah lokasi file config.php dan action.php yang biasanya terletak
pada
E:\xampp\htdocs\pear\PhpDocumentor\docbuilder.
Bukalah file config.php dengan Notepad++ atau
editor lainnya.
Kemudian rubahlah code pada baris-53 yang kode
awalnya:
include_once("e:\xampp\htdocs\pear/PhpDocumentor/docbuilder/includes/utilities.php"
);
Menjadi
include_once("e:\\xampp\htdocs\pear/PhpDocumentor/docbuilder/includes/utilities.php"
);
Perhatikan, dalam hal ini kita hanya cukup menambahkn tanda \\ untuk menyatakan drive pada E. Hal ini juga dilakukan pada file action.php yang mengalami error juga.
Coba jalankan kembali http://localhost/pear/PhpDocumentor/ pada browser anda. Jika berhasil
tanpa error, maka tampilan sebagai berikut:
Perhatikan, dalam hal ini kita hanya cukup menambahkn tanda \\ untuk menyatakan drive pada E. Hal ini juga dilakukan pada file action.php yang mengalami error juga.
Setelah konfigurasi phpdoc berhasil. Selanjutnya kita
akan mencoba menerapkan phpdoc. Untuk melakukan percobaan ini, kita persiapkan dua
buah file php dalah hal ini kita beri nama persegi.php dan kubus.php. Ujicoba
juga bisa digunakan pada satu file saja.
Dalam ujicoba ini, kita akan mencoba
mendokumentasikan class parent dan class child dengan menggunakan prinsip
Inheritance.
Bukalah editor seperti Notepad++ dan ketikkan
script php berikut dan berinama persegi.php dan kubus.php.
Script persegi.php
<?php
/**
* This class is Parent of Kubus
* @author Detailed Technology Center
* @filesource persegi.php
* @version 1.0
*/
class persegi
{
/**
* a static variable
* @static
*/
public static $astaticvar = 0;
/**
* @todo initialize all func needed
* @access protected
* @param Integer $param1
* @param Integer $param2
*/
protected function persegi($param1,$param2)
{
//initialize all func needed
}
}
?>
Script kubus.php
<?php
/**
* This class is Child of persegi
* @author Detailed Technology Center
* @filesource kubus.php
* @version 1.0
*/
require_once 'persegi.php';
class kubus extends persegi
{
/**
* @todo initialize all func needed
* @access public
* @param Integer $param1
* @param Integer $param2
* @see Persegi Constructor
*/
public function kubus($param1,$param2)
{
//initialize all func needed
parent::persegi($param1,$param2);
}
private function staticFunc()
{
}
public function callerFunc()
{
}
}
?>
Untuk meng-generate phpdoc, ikut langkah berikut:
Ketikkan
http://localhost/pear/PhpDocumentor/
pada browser.Kemudian ketikkan lokasi file anda yang bernama persegi.php dan
kubus.php. Dalam contoh ini kedua file berada pada
E:\xampp\htdocs\php\persegi.php dan E:\xampp\htdocs\php\kubus.php yang
dipisahkan dengan koma untuk menyatakan file kedua.
Kemudian tentukan output dari hasil generate-nya.
Dalam kasus ini, output berada pada lokasi E:\jua dan tentukan format dari
hasil generatenya,misalnya kita menginginkan dalam bentuk HTML.
Langkah berikutnya, klik create dan silahkan cek
di folder output.
