在我刚开始写本博客的时候曾经提到过phpDocumentor(phpdoc),那个时候还不知道phpdoc是什么。phpDocumentor这东西就像javadoc的功能,可以为你的代码快速生成具有相互参照,索引等功能的API文档。phpDocumentor是PEAR下面的一个模块,所以要安装phpDocumentor,就得先把PEAR安装上再说。
1.在WINDOWS下,你的PHP目录里有个go-pear.bat,双击它,接下来就是回车的步骤了。这过程一般不会有什么问题,安装完PEAR之后,会在你的PHP目录下生成一些文件…
2.在命令下进行到你PHP目录,执行 Pear install phpDocumentor,这样就能安装phpdoc了。
3.双击导入PHP目录下的PEAR_ENV.reg文件到注册中
4.在PHP目录下,执行pear list 查看已经安装的模块,你应该可以看到phpDocumentor已经安装好了。如下:
INSTALLED PACKAGES, CHANNEL PEAR.PHP.NET:
=========================================
PACKAGE VERSION STATE
Archive_Tar 1.3.3 stable
Console_Getopt 1.2.3 stable
PEAR 1.9.0 stable
PhpDocumentor 1.4.3 stable
Structures_Graph 1.0.2 stable
XML_Util 1.2.1 stable
phpdoc运行原理:
1. phpdoc扫描指定目录下面的php源代码,扫描其中的关键字,截取需要分析的注释,然后分析注释中的专用的tag,生成xml文件,接着根据已经分析完的类和模块的信息,建立相应的索引,生成xml文件
2. 对于生成的xml文件,使用定制的模板输出为html文件。
让我们看看wordpress的phpdoc吧。去http://cn.wordpress.org/下载一个最新的wordpress,解压…
3.在php.ini中把memory_limit = 128M,改成512或者原来比更大的数字。因为phpdoc运行起来消耗资源挺大,如果太小运行过程中会出错:Fatal error: Allowed memory size of 268435456 bytes exhausted (tried to allocate
40 bytes) in…
4.cd 到PHP目录,执行phpdoc.bat -d “C:\wordpress” -t “C:\wordpressdoc” -o “HTML:frames:phpedit”
-d表示你要扫描的是目录,-t表示你的生成目录,-o表示生成的格式,这里是HTML,完成后可以在wordpressdoc目录下用浏览器打开index.html来浏览生成的文档。
5.等待完成…