文档章节

使用 ApiGen 生成开发文档

依宸2016
 依宸2016
发布于 2016/11/11 12:19
字数 956
阅读 41
收藏 0

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

本文转载自:http://blog.csdn.net/liwb1987/article/details/49587031

依宸2016
粉丝 1
博文 94
码字总数 0
作品 0
济南
高级程序员
私信 提问
[转]netbean下利用apigen生成php文档安装配置

利用piwigo进行了项目的二次开发之后,有感于这个开源框架的博大精深,想留个念想,所以想利用phpDocumentor在sublime下面生成文档。安装之后,控制台报错。找群友商量之后,有朋友推荐用net...

阿夏
2013/06/15
0
0
Netbeans7.2Beta版发布

http://netbeans.org/community/releases/72/ New Feature Highlights Performance Project scanning now on background, not blocking editor features and navigation Improved project sc......

一号男嘉宾
2012/05/25
152
0
NetBeans IDE 7.2 Beta 发布,显著提升性能

NetBeans IDE 7.2 Beta 发布了,该版本在性能方面和编码体验上有着显著的提升,Java 编辑器提供静态代码分析功能和智能项目扫描功能。该版本的 JavaFx 同时集成了场景构建器,支持多个 PHP ...

oschina
2012/05/23
4.6K
49
成为一个 PHP 专家:缺失的环节

这一篇文章是“Becoming a PHP Professional”系列 4 篇博文中的第 1 篇。 当浏览各类与PHP相关的博客时,比如Quora上的问题,谷歌群组,简讯和杂志,我经常注意到技能的等级分化。问题都类似...

oschina
2014/02/27
5.3K
54
windows下配置apigen

php版本的api生成工具 apigen,其官网只有linux版本的配置,而没有windows版本的 官网地址:http://www.apigen.org/ 下载 apigen.phar (http://apigen.org/apigen.phar) 在 同级目录下新建文...

牛奋Debug
2015/12/25
28
0

没有更多内容

加载失败,请刷新页面

加载更多

【AI实战】手把手教你深度学习文字识别(文字检测篇:基于MSER, CTPN, SegLink, EAST等方法)

文字检测是文字识别过程中的一个非常重要的环节,文字检测的主要目标是将图片中的文字区域位置检测出来,以便于进行后面的文字识别,只有找到了文本所在区域,才能对其内容进行识别。 文字检...

雪饼
今天
7
0
思维导图XMind 8 Pro 绿化方法(附序列号)

按部就班: Step 1 -全新下载最新版本的 Xmind 8(注必须是英文官方的版本,中文代{过}{滤}理网站的版本修改过,无法使用pj); Step 2 -安装完毕后,点击文末的下载按钮下载pj补丁文件包,将...

一只小青蛙
今天
10
0
数据结构(ER数据库)设计规范

表命名规范 表命名的规则分为3个层级,层级之间通过_分割,例如b_r_identity、d_l_identity。规约为: [leavel]_[type]_[name] [leavel] 表示数据库表的层级和功能,分为: s:业务无关的系统...

随风溜达的向日葵
今天
6
0
阿里Sentinel控制台源码修改-对接Apollo规则持久化

https://github.com/alibaba/Sentinel/wiki/%E5%9C%A8%E7%94%9F%E4%BA%A7%E7%8E%AF%E5%A2%83%E4%B8%AD%E4%BD%BF%E7%94%A8-Sentinel 动态规则扩展 https://github.com/alibaba/Sentinel/wiki......

jxlgzwh
昨天
8
0
在Linux系统中创建SSH服务器别名

如果你经常通过 SSH 访问许多不同的远程系统,这个技巧将为你节省一些时间。你可以通过 SSH 为频繁访问的系统创建 SSH 别名,这样你就不必记住所有不同的用户名、主机名、SSH 端口号和 IP 地...

老孟的Linux私房菜
昨天
13
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部