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.exe和php.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 里面,接着进行升级或安装就没有问题了。

使用CMD用pear下载的安装包在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

安装本地包: pear install tmp/PhpDocumentor-1.4.3.tgz

提示安装成功

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

11、使用phpdoc

最简单的用法是

phpdoc -d [SOURCE_PATH] -t [TARGET_PATH]

d代表路径directory,t代表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 计划中要进行的项目

如果觉得本文有收获,记得推荐一下哦!^_^

时间: 2024-10-01 08:50:55

windows下安装PhpDocumentor(phpdoc)笔记的相关文章

Python学习笔记(三)windows下安装theano

早就听说theano很难安装,这一次算是初步尝试,不知道会不会有其它问题. 0 参考材料 (1)win 8.1 64bit 深度学习theano 安装设置 (2)Windows下安装theano成功,但一import就报decode错是什么原因? (3)Wndows8.1 64bit环境下搭建深度学习平台之Theano安装配置 (4)deep learning学习环境Theano安装(win8+win7) 1 简单记录过程 (1)安装anaconda:Download Anaconda now!

windows下安装php笔记

为了更深入的理解下服务端的配置 ,上篇文章讲了如何在windows下安装apache , 接下来再研究下在windows下安装php并且结合apache运行php环境, 纯属学习用 ^^ ,如果嫌麻烦可以直接去安装集成环境(wamp等等). 一 : 下载安装程序 这里下载的也是压缩包,直接解压就可以了. 最新的php版本已达到7.1了,考虑到大部分项目都是5.x版本,这里以PHP 5.6 (5.6.23)版本为例子. php下载地址:http://windows.php.net/download

windows下安装mysql笔记

接着上几篇文章再来看下windows下安装mysql. 我这里是windows7 64位, 安装过程中还是遇到一些坑,这里记录下. 一.下载安装包 打开mysql官网下载页面:http://dev.mysql.com/downloads/mysql/ 选择相应的版本和平台 这里选择的是5.7.13版本64位的 压缩包, 文件有310M比较大. 点击Download进入真正的下载页面,发现要登录才能下载 ,要细心点会发现下面有No thanks, just start my download. 就

MongoDB笔记1:Windows下安装MongoDB

Windows下安装MongoDB非常简单.若是32位的操作系统,要安装32位的MongoDB:若是64位的系统,要安装64位的MongoDB. 这里以64位为例.具体步骤为: 一.下载MongoDB最新或较新版,这里下的是 mongodb-win32-x86_64-2008plus-ssl-3.2.0-signed.msi 二.安装 1 双击mongodb-win32-x86_64-2008plus-ssl-3.2.0-signed.msi,启动安装向导界面.选"Next"按纽 2

windows下scrapy框架学习笔记—&#39;scrapy&#39; 不是内部或外部命令

最近几天在深入的学习scrapy框架,但是装完各种需要的基础包之后却发现scrapy命令在别的路径下都用不了,我一开始是把python安装在F:\Python路径下的,安装了scrapy后它默认都会安装在这个路径下,scrapy在路径F:\Python\Scripts路径下,我的scrapy命令只能在此路径下用,因此创建什么工程也都只能在此文件下. 想了一下它的工作原理:它在F:\Python\Scripts路径下,就会在Scripts文件下存在一个scrapy批处理文件,那么在DOS下想要命令

Windows 下安装 swoole 具体步骤

Windows 下安装 swoole 具体步骤: Swoole,原本不支持在Windows下安装的,所以我们要安装Cygwin来使用.在安装Cygwin下遇到了很多坑,百度经验上的文档不是很全,所以我把自己安装Cygwin和Swoole写下来相当于对自己的沉淀吧. 首先准备工具: Cygwin 官方地址:http://www.cygwin.com/ swoole 官方下载地址:https://github.com/swoole/swoole-src/releases 一.下载Swoole和Cyg

windows下安装redis

1.redis简介redis是一个key-value存储系统.和Memcached类似,它支持存 储的value类型相对更多,包括string(字符串).list(链表).set(集合).zset(sorted set --有序集合)和hashs(哈希类型).这些数据类型都支持push/pop.add/remove及取交集并集和差集及更丰富的操作,而且这些操作都 是原子性的.在此基础上,redis支持各种不同方式的排序.与memcached一样,为了保证效率,数据都是缓存在内存中.区别的是red

在 Windows 下安装 GruntJS

在你安装 Grunt.js 之前你需要先安装 Node.js.对于本教程而言,我已经安装好了 node.js v0.10.0. 我将要安装 Grunt.js v0.4.1.警告:如果你已经安装了 Grunt.js 0.3.x 或者更低的版本,请先卸载它. Grunt 的命令行界面 为了安装 grunt.js,我们需要要安装好全局的 Grunt 命令行界面(CLI),当前的 CLI 版本是 1.0.6.打开 Windows 命令窗口(CMD)并输入以下指令: npm install grunt-c

在windows下安装OpenDaylight的Helium(氦)版本

前言 OpenDaylight(以下简写为ODL)的Helium(氦)版本已经成为相对稳定的版本(相对于Li版本).Helium(氦)版本下载链接地址为http://www.opendaylight.org/software/downloads/helium.官网中分别共享了版本.安装向导.用户向导.开发者向导手册,可进行下载学习.在本篇文章中,着重讲一下在Windows下的安装过程. 1 Helium安装 虽然官方要求ODL Helium(氦)版本是基于Ubuntu的,但是在实际学习过程中,U