使用 ApiGen 生成开发文档

转载地址：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