phpdocumentor安装和使用总结】的更多相关文章

为了解决一校友在安装和使用phpDocumentor过程中遇到的问题,自己闲时也折腾了一下这个东西,总结见下: 一.定义: 自己刚听到这个词时还不知道这个是什么东西,干啥用的,就去百度了一下,说道: "phpDocumentor是用php语言写的一个非常强大的文档自动生成工具,利用它可以帮助我们编写规范的注释,生成易于理解,结构清晰的文档,对我们的代码升级,维护,移交等都有非常大的帮助": 二.安装: 我实验的环境是win8 + wamp集成环境(php5.4.16), 首先是查看自己…
phpDocuemtor官网:http://www.phpdoc.org/ 通过pear安装,进入dos的php目录,输入pear install -a PhpDocumentor.如果想使用web接口,则必须首先改变一个配置,参考:http://developer.51cto.com/art/200912/166582.htm. 终端:phpdoc -h   可以查看所有的指令,选几个重要的: -d     源php文件的路径 -t      生成文档后文档的存放路径(最好为其单独创建一个文件…
一  缘由 最近改版公司网站和app端的api,发现很多函数和方法都没写注释,搞得每次调用之前还需要看底层实现,有的方法名和功能还类似,区分不出使用哪个最优!为了避免给后人挖坑,除了将代码写得规范外,还想自动生成api文档,方便后来人!于是就研究上了phpdocumentor.今天说下它的安装以及使用.首先需要声明的是,网站的教程很多,但问题在于,按照网上的一些教程来,坑爹,老失败.于是干脆自己动手写一篇,记录下自己的经历. 二  安装 安装的环境是win10+xampp, 1      php…
PhpDocumentor简介 PHPDocumentor是一个用PHP写的工具,对于有规范注释的php程序,它能够快速生成具有相互参照,索引等功能的API文档.老的版本是phpdoc,从1.3.0开始,更名为phpDocumentor,新的版本加上了对php5语法的支持,同时,可以通过在客户端浏览器上操作生成文档,文档可以转换为PDF,HTML,CHM几种形式,非常的方便. 参考介绍: 百度百科:http://baike.baidu.com/view/1269751.htm 维基百科:http…
官网地址:http://www.phpdoc.org/ 项目地址:https://github.com/phpDocumentor/phpDocumentor2 phpDocumentor 2是一个可以 分析php源代码和注释块并生成文档的程序. 基于phpdocumentor 1和javadoc启发而来,它持续创新的使用了一些新技术和支持php的新特性. phpDocumentor 2的特点: 兼容php5.3,全面支持命名空间和闭包等. 识别支持任何tag,以及一些追加的 (比如 @link…
1.安装PEAR   官方网站: http://pear.php.net/   PHP 5.4 的 Windows 包中没有自带 PEAR,下载 http://pear.php.net/go-pear.phar 到PHP目录,并运行: php go-pear.phar 安装完成后PHP目录下会产生一个名为 pear.bat 的批处理文件,并且会在系统中添加以下环境变量(用户变量,假定PHP安装在C:\php): PHP_PEAR_BIN_DIR=C:\php PHP_PEAR_DATA_DIR=…
phpDocumentor, 分为文档性注释, 和 非文档性注释; 命令为: phpdoc -h, -f, -d.... 提取/ 生成 程序的注释文档, 实际上有很多种工具, 如: doc++, doxygen = dox-y-gen= doxy-generate, ..., 而php的注释文档生成工具是: PhpDocumentor... 安装好pear, phpdoc后,会在/usr/share/中生成pear和pear-data两个目录. 其中pear下是它的核心代码文件,包括inc文件和…
phpDocument是一个通用的生成PHP文档的工具,他本身也是用PHP写的,跟JAVADoc有些相似,但他有不同于PHPDoc,他比PHPDOC要快,而且能够解析的PHP范围更广,他本身包含了11个摸版,并且还能够生成WINDOWS的chm格式,或PDF.XML DocBook等.      官方地址 http://pear.php.net/package/PhpDocumentor      下载页面地址 http://pear.php.net/package/PhpDocumentor/…
PHPDocumentor当前版本是phpDocumentor-2.8.5.tgz 关于PHPDocumentor有什么用,还有其历史,我就不介绍了,直接进入正题.老版本的叫PHPDoc,从1.0开始,2017/2月的最新版本是:1.4.4(PHPDoc已经停止发布了直接新版本走起吧,新版本支持更好)新版本叫PHPDocumentor,从2.0本版本开始,2017/2月的最新版本是:2.8.52.0的官方网站:https://phpdoc.org 一 安装phpDocumentor 安装phpD…
1. 首先安装pear: curl -o go-pear.php https://pear.php.net/go-pear.phar 看见这个就安装OK: % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed100 3512k 100 3512k 0 0 392k 0 0:00:08 0:00:08 --:--:-- 732k 2. 然后执行: 会发现…