windows下安装PhpDocumentor(phpdoc)笔记

<div id="cnblogs_post_body" class="blogpost-body">
<div class="Section0">
<p class="p0">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

<img src="https://www.52php.cn/res/2019/04-01/23/51e409b11aa51c150090697429a953ed.gif" alt="复制代码">

?运行?->?输入cmd回车，切换到php.exe所在目录

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

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

第一步：安装pear（同上）?
此处给出下载地址：http://pear.php.net/go-pear.phar?
将 go-pear.phar 放到 PHP 目录下执行安装命令：

下面会执行输入?

然后一路回车安装完毕。

第二步：接下来安装类关系绘图用到的工具

pear install image_graphviz?
下载 http://www.graphviz.org/Download_.php graphviz-2.38.msi?
安装后，注意环境变量 path 添加上该 bin 的路径，重启，否则无法生效

第三步：安装 phpDocumentor

稍等一会，安装步骤完成！?
注意：两个安装后的目录都在PHP 下的 pear 下面：

显然：version2 比version1速度快了很多。

范例：test.php

class MyClass {

/**



这里是变量的说明


@var int

*/

var $a ;

/**


这里是变量的说明.




@var string 这里也可以放说明

*/

var $b ;


/**

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

*/

function first ( $a ) {

return array();

}
}
?>

<img src="https://www.52php.cn/res/2019/04-01/23/51e409b11aa51c150090697429a953ed.gif" alt="复制代码">

?

@author 程序作者名称，联络方式
@const 常数
@deprecate 不建议使用的 API
@global 全域变量
@param 函数的参数
@return 回传值
@see 可参考函数
@since 开始时间
@static 静态变量
@var 物件成员变量
@todo 计划中要进行的项目

<img src="https://www.52php.cn/res/2019/04-01/23/51e409b11aa51c150090697429a953ed.gif" alt="复制代码">

?

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

?

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!