windows下安装配置、使用phpdocumentor

前言

我们先来说说这是个啥，这是个php的文档自动生成工具。只要你在代码里面按照phpdocumentor的规范写注释，就可以生成各种格式的doc文档。方便查看。
官网：https://docs.phpdoc.org/

安装配置

相信大家的php已经是配置好的吧？

第一步，安装pear：https://blog.csdn.net/qq_39545346/article/details/110188120
第二步，安装：https://docs.phpdoc.org/latest/guide/getting-started/installing.html
需要注意的是，最新版本是phpdocumentor3.0，你的php版本需要是7.2.5及以上，如果是低版本的。请绕路：phpdocumentor1.0和2.0

测试使用

文档里面注释的规范说明，请去官网看看。我英文贼烂，网上又没找到合适的中文文档说明，这里就不写中文的使用注释了。

我们先写个简单的使用案例

/**
     * 函数add,实现两个数的加法
     *
     * 一个简单的加法计算，函数接受两个数a、b，返回他们的和c
     *
     * @param int 加数
     * @param int 被加数
     * @return int
     * @author tjx
     */
    public function Add(int $a, int $b)
    {
        return $a + $b;
    }

然后去php的安装根目录执行一下：

php phpDocumentor.phar -d D:\WWW\my_test\application -t D:\WWW\phpdoc\my_test

或者这样：

phpdoc -d D:\WWW\my_test\application -t D:\phpstudy_pro\WWW\phpdoc\my_test

第二种方法得确保你安装成功了phpdocumentor，并配置好了环境变量

参数说明：
-d 指定你的项目目录
-t 指定文档生成目录

效果截图

使用感想

刚开始用，还没有深入研究。这个东西国内用的比较少。整体感觉比较鸡肋。如果想用它作为服务端开发的查找手册还可，如果作为客户端的对接手册感觉差点意思。还是老老实实写规范的客户端对接文档吧。