http://www.phpdoc.org/

standard auto-documentation tool for the php language

http://blog.darkhero.net/articles/view/263

<?php
/**
 * 這裡是這個物件的說明
 * 可以多行喔!~
 *
 */
class MyClass {
    /**
     * 這裡是變數的說明
     *
     * @var int
     */
    var $a ;
    /**
     * 這裡是變數的說明.
     *
     * @var string 這裡也可以放說明
     */
    var $b ;
    
    /**
     * 這是針對函式的說明
     * 也是一樣可以多行
     * 若是簡單的範例也可以放這裡
     *
     * @param int $a 可以放入傳入的型態
     * @return array 可以說明回傳的型態
     */
    function first ( $a ) {
        return array();
    }
}
?>

常用到的參數

• @author 程式作者名稱，聯絡方式
• @const 常數
• @deprecate 不建議使用的 API
• @global 全域變數
• @param 函數的參數
• @return 回傳值
• @see 可參考函數
• @since 開始時間
• @static 靜態變數
• @var 物件成員變數
• @todo 計畫中要進行的項目