PHP的上学–使用PhpDocumentor 2生成API文书档案

 

官网地址:http://www.phpdoc.org/

类型地址:https://github.com/phpDocumentor/phpDocumentor2

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

依照phpdocumentor
1和javadoc启发而来,它不止更新的行使了一些新技巧和支撑php的新特色。

phpDocumentor 2的特点:

  • 分外php5.3,周详帮助命名空间和闭包等。
  • 鉴定识别帮衬别的tag,以及部分充实的 (比如 @link). 
  • 更快的处理速度。 较  phpDocumentor 1在Zend
    Framework 下的处理耗费时间有了深入人心的回落。
  • 低内部存款和储蓄器消耗,小中山大学型工程的内部存款和储蓄器消耗分别低于20MB,40MB和100MB。
  • 增量解析。即使您有在此以前运营phpdoc获得的structure.xml文件,那么小修改后再行生成文书档案的进程将荣升八成。
  • 简易就能制造模板,只需1小步和编写制定一个文本。
  • 匹配1代的命令行。例如 –directory, –file and –target 
  • 两步式处理。首先生成structure文件,你能够根据那一个文件来格式化相关消息,用自身的工具来呈现音讯!

安装须要:

安装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[=”…”]]

 

 

相关文章