ApiGen4.1 windows安装教程，apigen4.1教程

ApiGen4.1 windows安装教程，apigen4.1教程

 

一. 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.知名案例：

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执行文件地址） <span>"</span><span>%~dp0apigen.phar</span><span>"</span> %*

例如

@D:\xampp\php\php.exe <span>"</span><span>%~dp0apigen.phar</span><span>"</span> %*

另存为apigen.bat

3.将apigen.phar及apigen.bat文件复制或移动到环境变量PATH任一目录中。

windows7 对应目录为 C:\Windows\System32

4.在命令行中执行apigen出现版本及相关命令信息则证明安装成功。

c:\><span>apigen
ApiGen version </span><span>4.1</span>.<span>0</span><span>

Usage:
 command [options] [arguments]

Options:
 </span>--help (-<span>h)    Display this help message.
 </span>--quiet (-<span>q)   Do not output any message.
 </span>--version (-<span>V) Display this application version.

Available commands:
 generate      Generate API documentation
 help          Displays help </span><span>for</span><span> a command
 list          Lists commands
 self</span>-<span>update   Updates apigen.phar to the latest available version
 selfupdate    Updates apigen.phar to the latest available version</span>

5.执行生成apigen文档命令。

apigen generate --source <span>"</span><span>php项目地址</span><span>"</span> --destination <span>"</span><span>文档导出地址</span><span>"</span>

完整示例

apigen generate --source <span>"</span><span>D:\web\ruionline</span><span>"</span> --destination <span>"</span><span>D:\web\ruionline\doc</span><span>"</span>

<p>导出生成过程</p>

<p>最终生成目录结构 </p>

<p>web展示效果</p>

三.apigen命令参数详细说明

--source <path>需要编译成文档的 Project 目录， --source <path><span> 同时可以指定多个
</span>--destination <path><span>  编译后存放的目录路径
</span>--title <Name><span>  文档首页的标题
</span>--exclude <path> 排除的目录（如 <span>'</span><span>views/*</span><span>'</span><span> 表示视图目录下的不生成文档）

Options:
 </span>--source (-s)        Dirs or files documentation is generated <span>for</span><span>. (multiple va
lues allowed)
 </span>--destination (-d)   Target <span>dir</span> <span>for</span><span> documentation.
 </span>--access-<span>levels      Access levels of included method and properties. (default:
 [</span><span>"</span><span>public</span><span>"</span>,<span>"</span><span>protected</span><span>"</span><span>]) (multiple values allowed)
 </span>--annotation-<span>groups</span><span>  Generate page with elements with specific annotation.
 </span>--base-url           Base url used <span>for</span> sitemap (useful <span>for</span><span> public doc).
 </span>--config             Custom path to apigen.neon config <span>file</span>. (default: <span>"</span><span>E:\\ide</span>
/apigen.neon<span>"</span><span>)</span>
 --google-cse-<span>id</span>      Custom google search engine <span>id</span> (<span>for</span><span> search box).
 </span>--google-<span>analytics   Google Analytics tracking code.
 </span>--<span>debug              Turn on debug mode.
 </span>--deprecated         Generate documentation <span>for</span><span> elements marked as @deprecated
 </span>--<span>download           Add link to ZIP archive of documentation.
 </span>--extensions         Scanned <span>file</span> extensions. (default: [<span>"</span><span>php</span><span>"</span><span>]) (multiple valu
es allowed)
 </span>--<span>exclude            Directories and files matching this mask will not be parse
d (e.g. </span>*/tests<span>/*</span><span>). (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, b
ut 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 templateThem
e.
 --title              Title of generated documentation.
 --todo               Generate documentation for elements marked as @todo.
 --tree               Generate tree view of classes, interfaces, traits and exce
ptions.
 --help (-h)          Display this help message.
 --quiet (-q)         Do not output any message.
 --version (-V)       Display this application version.</span>

四.apigen支持php注释详解

<p>支持官方PSR-5标准</p>

1.Custom

<span>@deprecated
package
subpackage
copyright
license
author
version
since
see
uses
internal
todo
Standard</span>

2.param

<span>return</span><span>
throws
{@inheritdoc}
Magic methods and properties</span>

3.property

property-<span>read
property</span>-<span>write
method</span>