使用phpdoc生成類的說明文檔

安裝phpdocphp

pear install PhpDocumentor

經常使用的phpdoc命令參數html

-f 要進行分析的文件名,多個文件用逗號隔開.net

-d 要分析的目錄,多個目錄用逗號分割日誌

-t 生成的文檔的存放路徑code

-o 輸出的文檔格式,結構爲輸出格式:轉換器名:模板目錄htm

以我開發的日誌類爲示例:ip

phpdoc -o HTML:frames:earthli -f Logger.php -t /doc

訪問doc中的index.html便可以看到文檔。pdo


phpdoc規範中有不少標籤,通常使用幾個經常使用的標籤便可方便的閱讀,具體以下:開發

@access private|public|protect 類的訪問權限文檔

@param integer|string|array|... 方法參數的類型

@return integer|string|array|... 返回值的類型

@var integer|string|array|... 類變量的類型


具體代碼和文檔說明點擊這裏下載。

相關文章
相關標籤/搜索