安装PhpDocumentor PEAR包

0×01. PhpDocumentor PEAR包的安装
最近这几天在windows 7上面工作,写下win7下面的安装方法吧。linux 直接从软件源安装,很是方便。相比之外win下就稍微麻烦些了。
如果你从来没有安装过pear包,首先得执行一下 go-pear.bat (位于PHP目录下面),这个会默认设定一些配置项。
PS:
我的PHP以zip包解压安装在 d:\software\PHP
Apache www根目录是 d:\htdocs
下面是我的配置:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
d:\software\PHP>pear config-show
CONFIGURATION (CHANNEL PEAR.PHP.NET):
=====================================
Auto-discover new Channels     auto_discover    <not set>
Default Channel                default_channel  pear.php.net
HTTP Proxy Server Address      http_proxy       <not set>
PEAR server [DEPRECATED]       master_server    pear.php.net
Default Channel Mirror         preferred_mirror pear.php.net
Remote Configuration File      remote_config    <not set>
PEAR executables directory     bin_dir          D:\software\PHP
PEAR documentation directory   doc_dir          D:/htdocs/docs
PHP extension directory        ext_dir          D:/software/PHP/ext
PEAR directory                 php_dir          D:\software\PHP\pear
PEAR Installer cache directory cache_dir        D:\tmp
PEAR configuration file        cfg_dir          D:\software\PHP\cfg
directory
PEAR data directory            data_dir         D:/htdocs/pear
PEAR Installer download        download_dir     D:\tmp
directory
PHP CLI/CGI binary             php_bin          .\php.exe
php.ini location               php_ini          <not set>
--program-prefix passed to     php_prefix       <not set>
PHP's ./configure
--program-suffix passed to     php_suffix       <not set>
PHP'
s ./configure
PEAR Installer temp directory  temp_dir         D:\tmp
PEAR test directory            test_dir         D:\tmp
PEAR www files directory       www_dir          D:\software\PHP\www
Cache TimeToLive               cache_ttl        3600
Preferred Package State        preferred_state  stable
Unix file mask                 umask            0
Debug Log Level                verbose          1
PEAR password (for             password         <not set>
maintainers)
Signature Handling Program     sig_bin          c:\gnupg\gpg.exe
Signature Key Directory        sig_keydir       D:\software\PHP\pearkeys
Signature Key Id               sig_keyid        <not set>
Package Signature Type         sig_type         gpg
PEAR username (for             username         <not set>
maintainers)
User Configuration File        Filename         D:\software\PHP\pear.ini
System Configuration File      Filename         D:\software\PHP\pearsys.ini

主要是设置这几个:

1
2
3
4
5
6
7
8
9
10
11
pear config-set bin_dir D:\software\PHP
pear config-set doc_dir D:/htdocs/docs
pear config-set ext_dir D:/software/PHP/ext
pear config-set php_dir D:\software\PHP\pear
pear config-set cache_dir D:\tmp
pear config-set data_dir D:/htdocs/pear
pear config-set download_dir D:\tmp
pear config-set php_bin D:\software\PHP\php.exe
pear config-set temp_dir D:\tmp
pear config-set test_dir D:\tmp
pear config-set www_dir D:/htdocs/pear/www

不然它默认搞到PHP目录下面,把目录搞得很乱。data_dir它默认会放到c:\php\pear下面,因此我们务必在配置好后再装东西。
运行go-pear.bat后会修改php.ini ,在最后添加:

1
2
3
;***** Added by go-pear
include_path=".;D:\software\PHP\pear"
;*****

即把PEAR的路径加入PHP的全局包含路径中来。

下面开始安装PhpDocumentor:

1
2
3
4
5
6
7
8
9
10
d:\software\PHP>pear install --alldeps PhpDocumentor
WARNING: channel "pear.php.net" has updated its protocols, use "pear channel-upd
ate pear.php.net"
to update
^C终止批处理操作吗(Y/N)? y

d:\software\PHP>pear channel-update pear.php.net
Updating channel "pear.php.net"
Update of Channel "pear.php.net" succeeded

d:\software\PHP>pear install --alldeps PhpDocumentor

这样,默认配置文件是D:\htdocs\pear\PhpDocumentor\phpDocumentor.ini ,可以通过修改此配置来指定要生成文档的php文件后缀。

然后就是修改 D:\software\PHP\phpdoc.bat , phpCli 的值一定要修改为php.exe的绝对路径,不然运行会出错:
SET phpCli=D:\software\PHP\php.exe

0×02 生成文档
a,用web 界面工具生成
启动apache ,访问 http://localhost/pear/PhpDocumentor/ 即可看到操作界面,这个就不多说了。
b,结合IDE
NetBeans IDE :
工具-》 选项 -》PHP -》 PhpDoc
在PHP脚本处点“搜索”或者自动填写:

1
D:/software/PHP/phpdoc.bat -o HTML:frames:DOM/earthli

后面的-o 参数是指定主题风格的,我个人比较喜欢的风格有:

HTML:Smarty:PHP,
HTML:frames:DOM/earthli,
HTML:frames:earthli

然后再到“常规”里配置一下默认浏览器。
这样以后,选中一个项目,右键点击,在弹出的快捷菜单中选择“生成PhpDoc” 。然后会弹出窗口来让你选择目标输出目录,这里在windows下的话,最好在选择目录后再右键点击项目,选择“属性”,在PhpDoc 那里,“目标目录”处,将 反斜杠(\)修改为斜杠(/).因为
Netbeans IDE 这里有一个bug,会将windows下路径中的\ 当作转义字符,因而无法生成文档到目标目录。

更多
One Response Post a comment
  1. JetKing

    哈哈,我今天也在玩PhpDoc,在GOOGLE搜索关键字“phpdocumentor 输出风格”找到你这里来的。
    现在网上的文章真的是一大抄啊,找到的十有八九都是一样的内容。
    今天安装折腾了一下,感觉这玩意挺好用的,就是现在对输出的几种代码风格了解不大。(目前只试过smarty和默认的那种),再试试其它的。

Leave a Reply

Note: You may use basic HTML in your comments. Your email address will not be published.

Subscribe to this comment feed via RSS