首页研究院技术与艺术编程代码

PHPDocumentor 2.0在winows中的下载安装方法和使用说明

发布单位:索蓝时 发布时间:2012年3月17日 浏览次数:3387
声明:
1、为保护客户商业秘密或知识产权,部分文字、图片、声音、视频已经过处理,并非真实外观;
2、未经本公司许可,禁止以一切形式转载、摘编、复制本站的资源,本公司将追究违反上述声明者相关法律责任。

3月16日,phpdocumentor更新到了2.0,其模板好看了不少,生成效率也提高了,目前版本bug较多,暂不作为我SNANS公司的开发文档现定版,但未来一定会统一成2.0版本,至少那个界面太诱人了。在这里将陆续放上安装及使用说明,希望公司同事能及时学习。

本文初写于2012年3月17日,可能随着时间流逝,phpdocumentor2.0会改进bug和其他设置,因此请根据自己实际情况进行配置

 ---------------------------------------------------

一、下载

第一种方式就是手工下载(与官网相反),这种下载就不用说了,找到download,去吧~~~

https://github.com/phpDocumentor/phpDocumentor2

第二种方式就是利用pear的方式。

首先你得装好pear。

php5.3及以下版本点击php根目录go-pear.bat安装即可,而索蓝时公司现在使用的都是php5.4,要先去http://pear.php.net/go-pear.phar下载,记得是直接下载,不要点击链接,否则将出现一个文档,这个文档并不是真正的phar文件。

下载好后,放到php5的根目录,更名为pharcommand.phar(目录下原有的那个改个名字先)

然后点击phar.bat安装pear,其中基本按部就班,第一个问题输入local,其余的当然都是yes或者自己根据实际情况配置一下,如果不需要配置的直接按回车即可

这里需要提醒一下,如果你的电脑安全比较高,请先复制一个pear.ini到windows目录下,然后将其安全设置为允许修改,否则可能无法正常安装。

安装好后便使用目录中pear.bat下载phpdocument2.0,命令如下(这条命令官方文档中居然打成phpdocument/phpdocument,这是错误的,估计作者下次要修改的)

*命令如下:

pear install phpdoc/phpdocument

然后他会提示现在仅是2.0a1版本,请到channel:.............网址去下,ok我们的命令改一下

*命令如下:

pear install channel:...........

安装就这样结束了

---------------------------------------------------


二、配置

配置data目录下的phpdoc.tpl.xml,具体参数参考官方网站

 ---------------------------------------------------

三、运行

phpdocumentor1.4版本有web版,操作轻松,而目前2.0新出,没有网页版,于是某些喜欢黑白片的开发人员来劲了。

如果使用的是手工下载版(非pear),那么找到bin目录下的phpdoc.bat文件,用编辑器打开,修改其中php.exe和phpdoc.php的路径后再操作。

在windows7下,直接点击bat文件的话,界面将一闪而过,因此还是先用运行->cmd吧

我们说一下pear安装后的命令方法,这个和手工下载的方式几乎一致,仅仅是路径不同罢了

1、进入php5所在位置

*命令如下:

cd c:\php5

2、开始执行操作,现在版本根据官方网站的说明,只有简单的一行命令,没有模板选择。但本次官方模板够酷够炫够骚,我想以前那些模板可以扔掉了(以前1.4的模板直接复制过来是没用的)。

原来的好几个命令参数也已经没用了,比如-o

*命令如下(-d 表示源文件夹,-t表示目标文件夹):

1、pear方式

phpdoc run -d e:\test -t e:\guide

2、手动安装方式

php e:\phpdocument\bin\phpdoc.php run -d e:\test -t e:\guide

然后就开始解析了,如果一切正常,就会出现最新的说明文档,流泪又流汗啊。

 ---------------------------------------------------

四、问题

但也可能出现各种错误提示,我们这里先归纳几条:

问题一:

可能出现getAttribute不能执行的错误,这个错误的产生往往是因为你的目标文件夹中已经建立了一个structure.xml文件,所以每次解析前,请清空目标文件夹

问题二:

无法解析,目标文件夹下出现了css、img、js等等,但就是没有html,仔细看错误提示,便会发现我们的php没有开启xsl扩展,原来phpdocumentor是先根据源文件生成一个structure.xml,这个文件相当于一个小型数据库,然后再通过xml的数据生成html。知道了这个道理,那么这个问题就简单了,打开php.ini,找到extension,允许xsl并更新iis缓存~~

问题三:

手动安装方式生成说明文档很可能出错,只在目标文件夹生成一个structure.xml,其原因是我们使用的是iis服务器,而目前github下载的安装包中不带.htaccess,于是我们找到data\templates\responsive目录中的template.xml,将涉及.htaccess删去,重新生成一下即可

问题四:

生成文档,尤其类的说明链接出错,不知道怎么会多一个%5C,这是"/"的十六进制表示方法,解决办法,一个字:删

问题五:

phpdocument 2.0似乎与之前部分老的代码不匹配,例如原来的subpackage如果写在注释里,将导致package失效,而现在可使用@package first\second 式样的目录,更为直观

问题六:

目前对中文支持并不完美,比如“杠”字,请把“斜杠”改为“斜线”