phpDocumentor 及相關資源

phpDocumentor 及相關資源

# 安裝

在 php 目錄下運作： go-pear.bat pear.bat install -o PhpDocumentor

%%

# 指令行參數：

phpdoc -o HTML:frames:earthli -d /phproot/ -t /docs

　　-f 要進行分析的檔案名，多個檔案用逗号隔開 　　-d 要分析的目錄，多個目錄用逗号分割 　　-t 生成的文檔的存放路徑 　　-o 輸出的文檔格式（即模闆），結構為"輸出格式:轉換器名:模闆目錄"。

%%

# 常用模闆

HTML:Smarty:PHP HTML:frames:earthli

%%

# 關鍵的注釋文法：

檔案頭說明： <?php

// 其它代碼 ?>

其它如函數，類，常量的說明，直接用： <?php // 其它代碼

function name(){} ?>

其它标記及文法，比如函數參數說明，傳回值等，參考下面“參考資料”列出的内容。

%%

# 中文亂碼

把使用到的模闆目錄下 template 目錄中的 header.tpl ，發送的頭資訊編碼改為項目源代碼的編碼，比如 gbk 就可以了。

%%

# 參考資料：

寫好代碼注釋，生成代碼說明文檔，PhpDocumentor http://www.d5s.cn/archives/88 // 中文亂碼

PHPDocumentor安裝與使用 http://www.studyday.net/2011/04/196 // 安裝

還是phpDocumentor的安裝和使用 http://www.tsingfeng.com/?p=160 // 安裝，提到 -0 參數

(轉載)phpDocumentor筆記 http://www.tsingfeng.com/?p=153 // 比較詳細

phpDocumentor http://baike.baidu.com/view/1269751.htm // 比較詳細

PHPDoc http://zh.wikipedia.org/wiki/PHPDoc // 比較詳細

phpDoc(PHP Documentor) 标簽使用指南 http://lugir.com/book/export/html/290 // 寫得很好，可惜内容不完整

phpDocumentor學習記錄 http://luchuan.iteye.com/blog/954147 // 可作為補充參考