先说明一下.phpdocumentor这个软件我很早以前就有了解过.那个时候是因为看到cakephp里的文档里面也是用这个软件来生成api手册的.当时只是有点好奇,了解了一下他们内容.但没有实际去安装这个软件.因为还没有觉得自己有这个需要,所以就没有再了解下去了.
最近我开始重新规划我网站的内核了.这个时候再看我的程序就会发现,之前写得注释有点乱,不能让我一看就明白,而且很多时候,我还是直接看代码的.这样 对于别人使用在看我的程序时会觉得有点难以理解.
今天早上的时候,我就再试着安装phpdocumentor.因为他是一个很好的软件.我把我的注释安规定写好,让phpdocumentor生成好API,我能直接看API就知道怎么用.这样就知道我的注释写好了.别人也很方便学习怎么使用.这很不错的主意吧.
好的开始安装phpdocumentor了.不过在安装前,先安装好pear.
现在这里我主要以windows系统为主,我想很多人都是使用windows系统中开发的.而且生成phpdocument在windows下也挺容易理解的.
说说的我系统情况,我的windows环境是根据微米的WAMP升级而来的.所有Apache,mysql,php这三个软件我都是下载zip版,然后再重新安装得到的.
这里我就不谈怎么安装wamp了.你只需要确定php的安装目录中有一个go-pear.bat文件就可以了
如果没有,可以到
http://www.php.net/downloads.php
下载一个同样的php版本的zip压缩包,然后把里面的go-pear.bat文件及PEAR目录复制到php的安装目录就可以了.
打开cmd,进cd到php的安装目录
然后执行go-pear.bat,开始安装pear
运行后会看到提示我们是把pear安装到系统还是安装在本地.
我是选择本地(local)了.因为我不想跟系统拉上太多关系,以后重装系统水麻烦了.
按enter键后,会提示我们是否修改安装的路径.
我觉得安装在php目录下也不是什么问题,反正默认的对于一般使用者来说都是比较好的.
我直接enter键了.
下面会提示是不是要修改php.ini文件
输入"y"然后按enter键
现在开始安装phpDocumentor,其实安装这个是很简单的,基本上都是pear帮忙完成,连下载都不用管.输入:pear install phpDocumentor,如下图
整个过程都不用再插手了,pear会自动下载phpdocumentor并安装