d 生成文档存放目录
在使用之前，先修改下面2行：
phpdoc_dir="/usr/local/lib/php/pear/phpdoc" # windows: c:/php/pear/phpdoc
phpbin="/usr/local/bin/php" #windows: c:/php/php.exe
phpdoc_dir是phpdoc的目录，phpbin是php可执行文件的路径。
这个程序实际上是把php作为一个shellscript来使用了，不过是嵌在bash中使用，实际上php完全可以做为普通的shell脚本一样运行，只需加上 -q 参数，这样就不打印http header了。
6. 进阶：定制输出的文档
如果你认为缺省的phpdoc产生的html文档不够美观,你想做进一步的改进,比如你想把一些注释换成中文或者是其他的文字,你想加入你的logo,或者是你的联系方式,换成一个漂亮的背景图案,有没有方法可以作到?答案是当然可以,并且非常简单.
phpdoc在输出html格式的api文档的时候,使用的是pear的it,itx模块,这是类似phplib的templete.class的pear模块,因此,你可以方便地定制和修改缺省的模板来为你所用.
我们先看看phpdoc/renderer/html/templates: class.html classtree.html elementlist.html frame_packageelementlist.html
frame_packagelist.html module.html modulegroup.html packagelist.html phpdoc.css warnings.html xmlfiles.html
你会看到上面的这些文件,没错,这些就是phpdoc用来产生api html的模板,现在你可以用你的编辑器来修改这些模板了,这里给出基本的修改原则:
对于用{}圈起来的标记,这些是一些变量的标记,在运行时刻,phpdoc将会用实际的变量值替换到相应的位置.因此,你务必要保留全部的变量标记,否则运行时将会出错.
你要注意<!--begin xxx-loop --><!--end xxx -loop-->之类带loop的注释,在这2个标记中间的部分,将会用于循环输出,所以,你在设计模板时要考虑到循环使用,是否会破坏你页面的美观,最简单的比如:如果循环的部分是在一个表格内,你要用<tr>用来分隔各循环调用的部分,同时应该保证各个<td></td>是匹配关闭的.
当你修改的地方不大,你也可以直接修改样式表phpdoc.css的内容,这样也可以达到你要求的效果
你可以把模板存放在不同的目录，通过settemplatedirectory（）设置不同的模板路径，就可以生成不同格式的api文档
7. 参考资源
phpdoc home
phpdoc cvs
在使用之前，先修改下面2行：
phpdoc_dir="/usr/local/lib/php/pear/phpdoc" # windows: c:/php/pear/phpdoc
phpbin="/usr/local/bin/php" #windows: c:/php/php.exe
phpdoc_dir是phpdoc的目录，phpbin是php可执行文件的路径。
这个程序实际上是把php作为一个shellscript来使用了，不过是嵌在bash中使用，实际上php完全可以做为普通的shell脚本一样运行，只需加上 -q 参数，这样就不打印http header了。
6. 进阶：定制输出的文档
如果你认为缺省的phpdoc产生的html文档不够美观,你想做进一步的改进,比如你想把一些注释换成中文或者是其他的文字,你想加入你的logo,或者是你的联系方式,换成一个漂亮的背景图案,有没有方法可以作到?答案是当然可以,并且非常简单.
phpdoc在输出html格式的api文档的时候,使用的是pear的it,itx模块,这是类似phplib的templete.class的pear模块,因此,你可以方便地定制和修改缺省的模板来为你所用.
我们先看看phpdoc/renderer/html/templates: class.html classtree.html elementlist.html frame_packageelementlist.html
frame_packagelist.html module.html modulegroup.html packagelist.html phpdoc.css warnings.html xmlfiles.html
你会看到上面的这些文件,没错,这些就是phpdoc用来产生api html的模板,现在你可以用你的编辑器来修改这些模板了,这里给出基本的修改原则:
对于用{}圈起来的标记,这些是一些变量的标记,在运行时刻,phpdoc将会用实际的变量值替换到相应的位置.因此,你务必要保留全部的变量标记,否则运行时将会出错.
你要注意<!--begin xxx-loop --><!--end xxx -loop-->之类带loop的注释,在这2个标记中间的部分,将会用于循环输出,所以,你在设计模板时要考虑到循环使用,是否会破坏你页面的美观,最简单的比如:如果循环的部分是在一个表格内,你要用<tr>用来分隔各循环调用的部分,同时应该保证各个<td></td>是匹配关闭的.
当你修改的地方不大,你也可以直接修改样式表phpdoc.css的内容,这样也可以达到你要求的效果
你可以把模板存放在不同的目录，通过settemplatedirectory（）设置不同的模板路径，就可以生成不同格式的api文档
7. 参考资源
phpdoc home
phpdoc cvs
相关文章
 我来说两句 |
对此文章发表了评论 |
评论列表 （最新 评论仅限网友观点！）
推荐文章
热门文章
