ApiGen4.1 windows安裝教程

標籤：

 

一. ApiGen4.1版本介紹1.ApiGen介紹

ApiGen是自動產生PHP項目的閱讀文檔工具。 用於從PHP原始碼建立專業的API文檔，類似於phpDocumentor/phpDoc。

ApiGen4.1需要PHP 5.4+的版本支援

2.ApiGen官網地址

(1).OSCHINA地址www.oschina.net/p/apigen

(2).官網地址www.apigen.org

(3).github地址https://github.com/apigen/apigen#options

3.知名案例：

1. Amazaon Web Services
2. Doctrine
3. Nette
4. CakePHP

4.ApiGen風格樣式

官方推薦有預設和Twitter Bootstrap兩套風格樣式。

• ApiGen官方預設風格
•  
• ApiGen官方Bootstrap風格
•  

二.ApiGen windows安裝步驟1. 下載ApiGen。

官網地址http://www.apigen.org/

官網http://apigen.org/apigen.phar

2.編寫windows可執行bat檔案

開啟記事本寫入以下相關資訊，並另存新檔apigen.bat檔案。

> @（PHP.exe執行檔案地址） "%~dp0apigen.phar" %*

 

例如

@D:\xampp\php\php.exe "%~dp0apigen.phar" %*

 

另存新檔apigen.bat

3.將apigen.phar及apigen.bat檔案複製或移動到環境變數PATH任一目錄中。

windows7 對應目錄為 C:\Windows\System32

4.在命令列中執行apigen出現版本及相關命令資訊則證明安裝成功。

c:\>apigenApiGen version 4.1.0Usage: command [options] [arguments]Options: --help (-h)    Display this help message. --quiet (-q)   Do not output any message. --version (-V) Display this application version.Available commands: generate      Generate API documentation help          Displays help for a command list          Lists commands self-update   Updates apigen.phar to the latest available version selfupdate    Updates apigen.phar to the latest available version

 

5.執行產生apigen文檔命令。

apigen generate --source "php項目地址" --destination "文檔匯出地址"

 

完整樣本

apigen generate --source "D:\web\ruionline" --destination "D:\web\ruionline\doc"

 

匯出產生過程

 

最終組建目錄結構 

web展示效果

三.apigen命令參數詳細說明

--source <path>需要編譯成文檔的 Project 目錄， --source <path> 同時可以指定多個--destination <path>  編譯後存放的目錄路徑--title <Name>  文檔首頁的標題--exclude <path> 排除的目錄（如 ‘views/*‘ 表示視圖目錄下的不產生文檔）Options: --source (-s)        Dirs or files documentation is generated for. (multiple values allowed) --destination (-d)   Target dir for documentation. --access-levels      Access levels of included method and properties. (default: ["public","protected"]) (multiple values allowed) --annotation-groups  Generate page with elements with specific annotation. --base-url           Base url used for sitemap (useful for public doc). --config             Custom path to apigen.neon config file. (default: "E:\\ide/apigen.neon") --google-cse-id      Custom google search engine id (for search box). --google-analytics   Google Analytics tracking code. --debug              Turn on debug mode. --deprecated         Generate documentation for elements marked as @deprecated --download           Add link to ZIP archive of documentation. --extensions         Scanned file extensions. (default: ["php"]) (multiple values allowed) --exclude            Directories and files matching this mask will not be parsed (e.g. */tests/*). (multiple values allowed) --groups             The way elements are grouped in menu. (default: "auto") --charset            Charset of scanned files. (multiple values allowed) --main               Elements with this name prefix will be first in tree. --internal           Include elements marked as @internal. --php                Generate documentation for PHP internal classes. --skip-doc-path      Files matching this mask will be included in class tree, but will not create a link to their documentation. (multiple values allowed) --no-source-code     Do not generate highlighted source code for elements. --template-theme     ApiGen template theme name. (default: "default") --template-config    Your own template config, has higher priority templateTheme. --title              Title of generated documentation. --todo               Generate documentation for elements marked as @todo. --tree               Generate tree view of classes, interfaces, traits and exceptions. --help (-h)          Display this help message. --quiet (-q)         Do not output any message. --version (-V)       Display this application version.

 

四.apigen支援php注釋詳解

支援官方PSR-5標準

1.Custom

@deprecatedpackagesubpackagecopyrightlicenseauthorversionsinceseeusesinternaltodoStandard

 

2.param

returnthrows{@inheritdoc}Magic methods and properties

 

3.property

property-readproperty-writemethod

 

ApiGen4.1 windows安裝教程