windows下安装PhpDocumentor(phpdoc)笔记

简介:
PhpDocumentor 简介
  PHPDocumentor是一个用PHP写的工具,对于有规范注释的php程序,它能够快速生成具有相互参照,索引等功能的API文档。老的版本是phpdoc,从1.3.0开始,更名为phpDocumentor,新的版本加上了对php5语法的支持,同时,可以通过在客户端浏览器上操作生成文档,文档可以转换为PDF,HTML,CHM几种形式,非常的方便。


参考介绍:

百度百科:http://baike.baidu.com/view/1269751.htm

维基百科:http://en.wikipedia.org/wiki/Phpdoc   

http://en.wikipedia.org/wiki/PhpDocumentor

官网:http://www.phpdoc.org/ 

手册文档:http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.pkg.html

本机环境介绍:

wamp集成环境,php版本5.2.11

安装目录: D:\phpsetup\php5 

php.exephp.ini.所在目录: D:\phpsetup\php5 

1、确认wamp环境能正常运行。

2、开始 -> 运行 -> 输入cmd回车,切换到php.exe所在目录

3、输入 go-pear.bat 

 

如有问题,修改go-pear.bat如下:



@ECHO OFF
set PHP_BIN=php.exe
%PHP_BIN% -d phar.require_hash=0 ./PEAR/go-pear.phar 
Pause

这里脚本会询问我们是否是选择服务器范围,还是本地拷贝,我们选择系统。默认就是选择系统,直接回车。

 

4、这里会列出pear路径配置,询问我们是否修改。回车接受,开始安装pear库。

 

5、安装过程中,会提示我们修改php.ihi设置inclue_path,输入y"回车继续安装。

注意:这里安装脚本设置的是自动修改php.ini设置include_path,就我观察,输入Y回车,php.ini并没有修改成功,这里为了保险,我们可以自己确认一遍include_path是否设置正确。

 

6、安装完成,提示我们导入pear环境变量注册表文件: D:\phpsetup\php5\PEAR_ENV.reg ,我们找到该文件,双击导入注册表。回车结束安装。该文件起设置pear环境变量的作用。

 

7、输入pear,确认pear是否成功安装,如果出现以下界面,就表示pear已经安装成功。

 

8、安装PhpDocumentor前的一些准备,升级pear,可能我们安装的pear版本会有点老,故这里要升级pear

输入:

pear upgrade pear

等升级完成,安装PhpDocumentor依赖包。

输入:

pear install XML_Parser
pear install XML_Beautifier

如果出现问题:missing structures/graph.php file...

解压 Structures_Graph-1.0.4.tgz ,将Structures目录复制到 PHP\pear 里面,接着进行升级或安装就没有问题了。

使用CMDpear下载的安装包在PHP\tmp目录里面。

升级所有包:pear upgrade-all



查看已经安装的包:pear list

Pear已经升级过了。

安装本地已经存在的包:

pear install XML_Parser-1.3.4.tgz

pear install tmp/PhpDocumentor-1.4.4.tgz

去掉tmp会从网络重新下载并覆盖

 

9、安装PhpDocumentor

输入:

pear install PhpDocumentor

10、输入  phpdoc -h ,得到下图所示,就表示安装成功了。 

 

 

11、使用phpdoc

 

最简单的用法是

phpdoc -d [SOURCE_PATH] -t [TARGET_PATH]

d代表路径directoryt代表target。或者可以选择-f来指定单个文件

制定好路径稍等片刻执行完毕就可以在target文件夹里看到说明文档了

例:phpdoc -f D:\phpsetup\php5\docs\PhpDocumentor\Documentation\tests\bug-441275.php -t new\

 

但这样不支持中文,我们使用下面的-o HTML:Smarty:PHP选项:

phpdoc -o HTML:Smarty:PHP -f d:\phpsetup\php5\tmp\test.php -t new

 

 

这样子的意思是说,采用 HTML:Smarty:PHP 的样板格式,然后原始码文件是d:\phpsetup\php5\tmp\test.php,接着把产生的文件放在当前new目录下。

当中若是你只要针对一个目的话,可以把 -f 改成 -d 然后后面接的着就是指定的档名。

 

样板的格式基本上有 HTML, XML, PDF, CHM 四大类别,通常我用的都是 HTML:Smarty:PHP 这个,因为他比较好看!

 

另外还有就是 CHM:default:default 这个.用来产生 chm 的,不过他产生出来的是 .hhp 档案,也就是还没有经过 HTML helper 编译过的档案,所以要另外安装 HTML Helper 来编译 hhp 档案就可以产生你要的档案。

 

-- 最后来说一下怎么写注解 --

 

phpDocumentor 的注解有一定的规格,但是都跟我们原来写注解的方式很像,只是要注意一下东西而已。

简单的来看个范例好了


范例:test.php





<?php
/**
* 这里是这个物件的说明
* 可以多行喔!~
*
*/

class MyClass {
   /**
   * 这里是变量的说明
   * @var int
   */
   var $a ;
   /**

   * 这里是变量的说明.
   *
   * @var string 这里也可以放说明
   */
   var $b ;

   /**
   * 这是针对函式的说明
   * 也是一样可以多行
   * 若是简单的范例也可以放这里
   * @param int $a 可以放入传入的型态
   * @return array 可以说明回传的型态
   */

   function first ( $a ) {
      return array();
   }

}

?>

 

基本上都是在



/**
*
*/

中间写注解,别忘了每行前面要有个 !

 

注解比较常用到参数的应该是

 

@author 程序作者名称,联络方式

@const 常数

@deprecate 不建议使用的 API

@global 全域变量

@param 函数的参数

@return 回传值

@see 可参考函数

@since 开始时间

@static 静态变量

@var 物件成员变量

@todo 计划中要进行的项目

目录
相关文章
|
20天前
|
存储 Cloud Native Java
Windows下Minio的安装以及基本使用
MinIO 是一个开源的云原生分布式对象存储系统,兼容亚马逊S3接口,适合存储大容量非结构化数据。本文介绍Windows下MinIO的安装与基本使用:通过以上步骤,您可以在Windows环境中成功安装并使用MinIO。
96 17
|
1月前
|
关系型数据库 MySQL 数据库
【MySQL基础篇】MySQL概述、Windows下载MySQL8.0超详细图文安装教程
在这一章节,主要介绍两个部分,数据库相关概念及MySQL数据库的介绍、下载、安装、启动及连接。接着,详细描述了MySQL 8.0的版本选择与下载,推荐使用社区版(免费)。安装过程包括自定义安装路径、配置环境变量、启动和停止服务、以及客户端连接测试。此外,还提供了在同一台电脑上安装多个MySQL版本的方法及卸载步骤。最后,解释了关系型数据库(RDBMS)的特点,即基于二维表存储数据,使用SQL语言进行操作,格式统一且便于维护。通过具体的结构图展示了MySQL的数据模型,说明了数据库服务器、数据库、表和记录之间的层次关系。
【MySQL基础篇】MySQL概述、Windows下载MySQL8.0超详细图文安装教程
|
1月前
|
安全 关系型数据库 MySQL
Windows Server 安装 MySQL 8.0 详细指南
安装 MySQL 需要谨慎,特别注意安全配置和权限管理。根据实际业务需求调整配置,确保数据库的性能和安全。
170 9
|
1月前
|
机器学习/深度学习 并行计算 异构计算
WINDOWS安装eiseg遇到的问题和解决方法
通过本文的详细步骤和问题解决方法,希望能帮助你顺利在 Windows 系统上安装和运行 EISeg。
113 2
|
2月前
|
网络安全 Windows
Windows server 2012R2系统安装远程桌面服务后无法多用户同时登录是什么原因?
【11月更文挑战第15天】本文介绍了在Windows Server 2012 R2中遇到的多用户无法同时登录远程桌面的问题及其解决方法,包括许可模式限制、组策略配置问题、远程桌面服务配置错误以及网络和防火墙问题四个方面的原因分析及对应的解决方案。
179 4
|
2月前
|
NoSQL Linux PHP
如何在不同操作系统上安装 Redis 服务器,包括 Linux 和 Windows 的具体步骤
本文介绍了如何在不同操作系统上安装 Redis 服务器,包括 Linux 和 Windows 的具体步骤。接着,对比了两种常用的 PHP Redis 客户端扩展:PhpRedis 和 Predis,详细说明了它们的安装方法及优缺点。最后,提供了使用 PhpRedis 和 Predis 在 PHP 中连接 Redis 服务器及进行字符串、列表、集合和哈希等数据类型的基本操作示例。
110 4
|
3月前
|
数据安全/隐私保护 Windows
安装 Windows Server 2019
安装 Windows Server 2019
107 1
|
3月前
|
Windows
安装 Windows Server 2003
安装 Windows Server 2003
|
3月前
|
Linux 网络安全 虚拟化
适用于Linux的Windows子系统(WSL1)的安装与使用记录
并放到启动文件夹,就可以开机自动启动了。
241 0
|
3月前
|
Windows
安装Windows XP系统
安装Windows XP系统
102 0

热门文章

最新文章