安装PHPDoc--WithGraphViz

应客户的要求需要提供一个类图以及类成员说明的文档，本来就没打算做，因此决定采用PHPDoc的形式交差。

为了避免今后走同样的弯路，在正式开始之前，记下这样的信息

一定要先安装GraphViz，再安装PhpDoc。

---

 

PHPDoc跟XDoc（JavaDoc，NDoc。。。）一样，根据注释生成HTML格式的程序帮助文档。

GraphViz用于绘制DOT语言脚本描述的图形。安装它之后PhpDoc可以输出类图。

本人安装的过程如下：

1.PHPDoc的主页：http://www.phpdoc.org/

2.执行:

pear channel-discover pear.phpdoc.org

pear install phpdoc/phpDocumentor-alpha

(pear的安装请参照另一篇博文 。)

3.当前目录设置为需要转换Doc的目录，即你的PHP代码所在目录。

   执行

phpdoc -d . -t C:\docs

C:\docs是生成PHPDoc的目标路径
发生如下错误：

 The XSL writer was unable to find your XSLTProcessor; please check if you have installed the PHP XSL extension

解决办法如下：

获取php_xsl (这个文件在我的php5.3.22上测试通过)，在PHP.ini中添加

extension=php_xsl.dll

4.再次运行

phpdoc -d . -t C:\docs

OK，在C：\docs目录下生成了HTML格式的说明。

5.但是，仔细查看执行phpdoc的执行结果发现命令行终端上出现如下错误：

  Unable to find the `dot` command of the GraphViz package. Is GraphViz correctl
y installed and present in your path?
  Unable to find the `dot` command of the GraphViz package. Is GraphViz correctl
y installed and present in your path?

打开生成的phpDoc,点击Charts菜单下的子菜单，发现PhpDoc还会生成类图，但是因为我没有安装GraphViz,没有办法实现。。。决定搞定它。

GraphViz官网:http://www.graphviz.org/

下载安装包，顺利装上不表。怀着激动的心情再次执行phpdoc命令，OMG！还是原来的错误提示，迫不急待打开命令行敲下“dot”命令。。。输出了dot的帮助信息，说明已经装上了。但是，肿么用不鸟！

执行

pear uninstall phpdoc/phpDocumentor-alpha

卸载PhpDoc!再重装!OMG！PHPDoc也装不上了(当时撞墙的心都有了)！提示错误信息：

No releases available for package ...

冷静下来仔细分析pear的命令参数，发现有一个参数是clear-cache，觉得可能是pear缓存了安装信息，所以认为本机已经安装过phpdoc。执行了一下clear-cache，然后重新安装PHPDoc，成功!重新执行PHPDoc的导出命令，成功！说明之前找不到GraphViz错误是因为安装顺序导致的，应该先安装GraphViz然后再安装phpDoc,打开生成的phpDoc,Chart也可以正常显示！oye！