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 相关文章推荐
PHP编程网上资源导航
Oct 09 PHP
Linux下将excel数据导入到mssql数据库中的方法
Feb 08 PHP
php json转换成数组形式代码分享
Nov 10 PHP
ThinkPHP框架设计及扩展详解
Nov 25 PHP
PHP多线程类及用法实例
Dec 03 PHP
php中file_exists函数使用详解
May 08 PHP
Zend Framework开发入门经典教程
Mar 23 PHP
ThinkPHP项目分组配置方法分析
Mar 23 PHP
PHP实现的XML操作类【XML Library】
Dec 29 PHP
老生常谈PHP数组函数array_merge(必看篇)
May 25 PHP
php封装一个异常的处理类
Jun 08 PHP
为何说PHP引用是个坑,要慎用
Apr 02 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
dedecms模板标签代码官方参考
2007/03/17 PHP
set_include_path在win和linux下的区别
2008/01/10 PHP
使用session判断用户登录用户权限(超简单)
2013/06/08 PHP
php修改NetBeans默认字体的大小
2013/07/02 PHP
在PHP模板引擎smarty生成随机数的方法和math函数详解
2014/04/24 PHP
CI框架学习笔记(一) - 环境安装、基本术语和框架流程
2014/10/26 PHP
微信自定义分享php代码分析
2016/11/24 PHP
thinkPHP订单数字提醒功能的实现方法
2016/12/01 PHP
在Laravel中使用MongoDB的方法示例
2019/11/11 PHP
jquery maxlength使用说明
2011/09/09 Javascript
jquery等宽输出文字插件使用介绍
2013/09/18 Javascript
JS中call/apply、arguments、undefined/null方法详解
2016/02/15 Javascript
浅谈js中的变量名和函数名重名
2017/02/13 Javascript
通过命令行生成vue项目框架的方法
2017/07/12 Javascript
Vue+Element使用富文本编辑器的示例代码
2017/08/14 Javascript
Webpack实战加载SVG的方法
2017/12/26 Javascript
微信小程序Flex布局用法深入浅出分析
2019/04/25 Javascript
python对数组进行反转的方法
2015/05/20 Python
Python语言进阶知识点总结
2019/05/28 Python
python读取大文件越来越慢的原因与解决
2019/08/08 Python
python实现拼图小游戏
2020/02/22 Python
python 中的paramiko模块简介及安装过程
2020/02/29 Python
python shell命令行中import多层目录下的模块操作
2020/03/09 Python
Python实现从N个数中找到最大的K个数
2020/04/02 Python
社区版pycharm创建django项目的方法(pycharm的newproject左侧没有项目选项)
2020/09/23 Python
CSS3感应鼠标的背景闪烁和图片缩放动画效果
2014/05/14 HTML / CSS
JAVA高级程序员面试题
2013/09/06 面试题
校领导推荐信
2013/11/01 职场文书
2014年大学生四年规划书范文
2014/04/03 职场文书
机械加工与数控专业自荐书
2014/06/04 职场文书
家长会标语
2014/06/24 职场文书
行政复议答复书
2015/07/01 职场文书
元宵节晚会主持词
2015/07/01 职场文书
OpenCV-Python实现人脸磨皮算法
2021/06/07 Python
Java实现注册登录跳转
2022/06/16 Java/Android
Win11 25163.1010更新补丁KB5016904推送,测试服务验证管道(附更新修复汇总)
2022/07/23 数码科技