PhpDocumentor 2安装以及生成API文档的方法


Posted in PHP onMay 21, 2014

官网地址:http://www.phpdoc.org/
项目地址:https://github.com/phpDocumentor/phpDocumentor2

phpDocumentor 2是一个可以 分析php源代码和注释块并生成文档的程序。

基于phpdocumentor 1和javadoc启发而来,它持续创新的使用了一些新技术和支持php的新特性。

phpDocumentor 2的特点:

    兼容php5.3,全面支持命名空间和闭包等。
    识别支持任何tag,以及一些追加的 (比如 @link).
    更快的处理速度。 较  phpDocumentor 1在Zend Framework 下的处理耗时有了明显的减少。
    低内存消耗,小中大型工程的内存消耗分别低于20MB,40MB和100MB。
    增量解析。如果你有之前运行phpdoc获得的structure.xml文件,那么小修改后重新生成文档的速度将提升80%。
    简单就能创建模板,只需1小步和编辑3个文件。
    兼容1代的命令行。例如 --directory, --file and --target
    两步式处理。首先生成structure文件,你可以根据这个文件来格式化相关信息,用自己的工具来展现信息!

安装需求:

    PHP 5.3.3 or higher
    ext/iconv, http://php.net/manual/en/book.iconv.php (从PHP 5.0.0版本起,默认开启)
    ext/intl, http://php.net/manual/en/book.intl.php
    The XSL extension, http://www.php.net/manual/en/book.xsl.php (可选,只在使用xsl的模板时使用)
    Graphviz (可选,用来生成类图)

安装phpDocumentor 2

1.依赖于 pear 进行安装:

下载 pear  http://pear.php.net/go-pear.phar

将 go-pear.phar 放到 PHP 目录下

执行安装命令:

php go-pear.phar

下面会执行输入 system

然后一路回车安装完毕

2.接下来安装类关系绘图用到的工具:

pear install image_graphviz

下载  http://www.graphviz.org/Download_windows.php   graphviz-2.38.msi

安装后,注意查看环境变量 path 中是否已添加上该 bin 的路径,

下面很重要的一步:重启电脑,否则无法生效

3.安装 phpDocumentor

pear channel-discover pear.phpdoc.org //注册channel
pear remote-list -c phpdoc //列出可以获得的版本
pear install phpdoc/phpDocumentor //安装phpDocumentor

详情参考:http://pear.phpdoc.org/

安装步骤完成!

提示下:

两个软件安装后的目录都在PHP 下的 pear 下面:

    php/pear/PhpDocumentor
    php/pear/Image

使用PhpDocumentor 2

下面开始生成项目文档:

在PHP根目录下:

phpdoc -d 项目绝对路径 -t 生成的文档存放的路径

d代表路径directory,t代表target。或者可以选择-f来指定单个文件。制定好路径稍等片刻执行完毕就可以在target文件夹里看到说明文档了。

例子:

phpdoc -d E:\bak\video\code -t E:\bak\video\code\doc

E:\bak\video\code  为php代码的文件夹

E:\bak\video\code\doc 为生成文档的文件夹

具体的参数如下:

project:run [-t|--target[="..."]] [-f|--filename[="..."]] [-d|--directory[="..."]] [-e|--extensions[="..."]] [-i|--ignore[="..."]] [--ignore-tags[="..."]] [--hidden] [--ignore-symlinks] [-m|--markers[="..."]] [--title[="..."]] [--force] [--validate] [--visibility[="..."]] [--defaultpackagename[="..."]] [--sourcecode] [-p|--progressbar] [--template[="..."]] [--parseprivate] [-c|--config[="..."]]
PHP 相关文章推荐
火车头采集器3.0采集图文教程
Mar 17 PHP
ajax php 实现写入数据库
Sep 02 PHP
PHP技术开发技巧分享
Mar 23 PHP
Can't create/write to file 'C:\WINDOWS\TEMP\...MYSQL报错解决方法
Jun 30 PHP
深入解析PHP的引用计数机制
Jun 14 PHP
PHP实现即时输出、实时输出内容方法
May 27 PHP
YII动态模型(动态表名)支持分析
Mar 29 PHP
php+jQuery+Ajax简单实现页面异步刷新
Aug 08 PHP
详解PHP归并排序的实现
Oct 18 PHP
PHP+Ajax异步带进度条上传文件实例
Nov 01 PHP
tp5(thinkPHP5)框架连接数据库的方法示例
Dec 24 PHP
Yaf框架封装的MySQL数据库操作示例
Mar 06 PHP
Smarty模板学习笔记之Smarty简介
May 20 #PHP
php实例分享之mysql数据备份
May 19 #PHP
dedecms函数分享之获取某一栏目所有子栏目
May 19 #PHP
ECMall支持SSL连接邮件服务器的配置方法详解
May 19 #PHP
PHP小技巧之JS和CSS优化工具Minify的使用方法
May 19 #PHP
php开启openssl的方法
May 15 #PHP
PHP整数取余返回负数的相关解决方法
May 15 #PHP
You might like
第三节 定义一个类 [3]
2006/10/09 PHP
浅谈PHP语法(1)
2006/10/09 PHP
php获取url字符串截取路径的文件名和扩展名的函数
2010/01/22 PHP
php中http与https跨域共享session的解决方法
2014/12/20 PHP
php curl登陆qq后获取用户信息时证书错误
2015/02/03 PHP
php添加数据到xml文件的简单例子
2016/09/08 PHP
THinkPHP获取客户端IP与IP地址查询的方法
2016/11/14 PHP
textarea中的手动换行处理的jquery代码
2011/02/26 Javascript
Extjs优化(一)删除冗余代码提高运行速度
2013/04/15 Javascript
jQuery实用技巧必备(下)
2015/11/03 Javascript
JS使用正则表达式过滤多个词语并替换为相同长度星号的方法
2016/08/03 Javascript
微信小程序 登录实例详解
2017/01/16 Javascript
jQuery插件FusionCharts实现的2D面积图效果示例【附demo源码下载】
2017/03/06 Javascript
Vue2.x中的父子组件相互通信的实现方法
2017/05/02 Javascript
nodejs socket实现的服务端和客户端功能示例
2017/06/02 NodeJs
JavaScript条件判断_动力节点Java学院整理
2017/06/26 Javascript
Jquery中.bind()、.live()、.delegate()和.on()之间的区别详解
2017/08/01 jQuery
让Vue也可以使用Redux的方法
2018/05/23 Javascript
微信小程序form表单组件示例代码
2018/07/15 Javascript
小程序的上传文件接口的注意要点解析
2019/09/17 Javascript
JavaScript中this的学习笔记及用法整理
2020/02/17 Javascript
[05:23]DOTA2-DPC中国联赛2月1日Recap集锦
2021/03/11 DOTA
Python将xml和xsl转换为html的方法
2015/03/10 Python
Python 中 list 的各项操作技巧
2017/04/13 Python
Python星号*与**用法分析
2018/02/02 Python
用python求一重积分和二重积分的例子
2019/12/06 Python
如何基于python操作json文件获取内容
2019/12/24 Python
Python figure参数及subplot子图绘制代码
2020/04/18 Python
美国最大的半成品净菜电商:Blue Apron(蓝围裙)
2018/04/27 全球购物
德国隐形眼镜店:LuckyLens
2018/07/29 全球购物
安全责任书范文
2014/03/12 职场文书
教师对学生的评语
2014/04/28 职场文书
换届选举主持词
2015/07/03 职场文书
新闻简讯格式及范文
2015/07/22 职场文书
拙作再改《我的收音机情缘》
2022/04/05 无线电
win10频率超出范围怎么办?win10老显示超出工作频率范围的解决方法
2022/07/07 数码科技