轉載地址：http://www.th7.cn/Program/php/201501/375666.shtml

ApiGen官網: http://www.apigen.org/

一、從 github 獲取 Windows 的安裝包

https://github.com/apigen/apigen/downloads

選擇 Version x.x.x standalone package (zip)

二、檢測、安裝運行環境

1.?進入PHP安裝目錄，按住shift鍵右擊鼠標，點擊“在此處打開命令窗口”(或使用cmd.exe進入目錄)，運行如下命令:

pear config-set auto_discover 1

運行的結果：

D:/php>pear config-set auto_discover 1

config-set succeeded

如果運行結果如上，直接進入“三、安裝ApiGen”，否則如下步驟安裝pear

2.?安裝pear

PHP官網下載：http://pear.php.net/go-pear.phar

然后將文件拷貝到PHP的安裝根目錄下，按上面的方式打開命令窗口，執行命令:

php go-pear.phar

出現提示選項，則選擇安裝 system

<system|local> [system] : system

后面全部回車，或在提示 'all or Enter'時輸入 all 回車

?

三、安裝使用ApiGen

1.?將ApiGen解壓到web目錄下或其他目錄，然后將 apigen.neon.example 重命名為 apigen.neon 即可，這個 apigen.neon 配置文件，似乎有些不太好使，比如更改模板 templateConfig 就沒生效，自定義的模板可以改/ApiGen/Config.php 配置文件（我將 default 改成了 bootstrap）:

public function __construct()

??????? {

?????????????? self::$defaultConfig['templateConfig']= $templateDir . DIRECTORY_SEPARATOR . 'templates' . DIRECTORY_SEPARATOR .'bootstrap' . DIRECTORY_SEPARATOR . 'config.neon';

??????? }

?

如果不想將整個源碼也展現出來，在 /ApiGen/Config.php 中將sourceCode 設為 false 即可:

private static $defaultConfig = array(

?????????????? 'sourceCode'=> false,

?????????????? 'charset'=> array('auto'),

??????? );

2.?在目錄中 按住shift鍵右擊鼠標，點擊“在此處打開命令窗口”，運行如下命令(參數見下面):

D:/www/apigen>phpapigen.php --source "../site" --destination "./docs"--title "Api Document" --exclude "runtime/*"

?

若提示 php不是內部命令，則將 PHP 的安裝目錄路徑添加到 系統 的 環境變量中，方法：

控制面板->系統->高級系統設置->環境變量->在“系統變量”的“Path”中添加，結尾加一個英文分號，然后再運行上面的命令。

?

若提示 memory 內存不足的錯誤，更改 php.ini 文件的內存設置，重啟Apache 再運行。

?

3.?回車后開始編譯，稍后就可以得到文檔，打開 index.html 就可以查看了

?

附、命令參數

--source <path>需要編譯成文檔的Project 目錄， --source <path> 同時可以指定多個

--destination <path> ?編譯后存放的目錄路徑

--title <Name> ?文檔首頁的標題

--exclude <path> 排除的目錄（如'views/*' 表示視圖目錄下的不生成文檔）

參考命令

<?php ??? exec('php D:\xampp\htdocs\apigen\apigen.php --source "D:\xampp\htdocs\smart\src" --destination "./apidocs" --title "smartcourse"'); ?>

?

Options:
--source (-s) 源碼文件目錄（可設置多個值）（必填）
--destination (-d) 文檔生成目錄（必填）
--access-levels 屬性及方法的訪問級別（默認："public","protected"）（可選）（可設置多個值）
--base-url 文檔根路徑
--config 自定義apigen.neon配置文件
--google-cse-id Custom google search engine id (for search box).
--google-analytics 谷歌統計代碼
--debug 開啟Debug模式
--deprecated 將標簽（@deprecated）生成棄用信息
--download 添加一個下載鏈接到ZIP歸檔文件
--extensions 允許解析的文件擴展名列表（默認："php"）（可設置多個值）
--exclude 被匹配的目錄和文件將不被解析（可設置多個值）
--groups 菜單項分組（默認："auto"）
--charset 源文件的字符集（可設置多個值）
--main 被匹配的名稱前綴生成為“主要項目”
--internal 包含標簽@internal
--php 生成PHP內部類文檔
--skip-doc-path 被匹配的文件將會出現在類樹中，但不會鏈接到這些文檔（可設置多個值）
--no-source-code 不高亮源代碼中的標簽
--template-theme 模板名稱（默認："default"）
--template-config 模板設置
--title 文檔標題
--todo 將標簽（@todo）生成任務文檔
--tree 生成類、接口、特征和異常的目錄樹
--help (-h) 顯示幫助信息
--quiet (-q) 不輸出任何信息
--version (-V) 顯示程序版本號

其他參數見 ApiGen官網 或https://github.com/apigen/apigen#options

與50位技術專家面對面20年技術見證，附贈技術全景圖

總結

以上是生活随笔為你收集整理的使用 ApiGen 生成开发文档的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。