README

PHP文档支持库。提供一个构建完整和功能丰富的文档生成应用程序的应用程序。

安装

composer require haodt/rylai

用法

查看rylai.php，该脚本用于构建此库的文档
将脚本克隆到您的项目中，更改路径以满足您的需求。每个路径代表一个存储库。
路径的键应该是您在composer.json中定义的根命名空间。请查看此库的composer.json文件以获取详细信息

require_once __DIR__ . "/vendor/autoload.php";

use Rylai\Analyzers\Docblock;
use Rylai\Runner\AbstractRunner;
use Rylai\Stores\Local;

class Runner extends AbstractRunner
{
    public function getPaths()
    {
        return [
            "Rylai" => __DIR__ . "/src/",
        ];
    }

    public function getAnalyzers()
    {
        return [
            new Docblock,
        ];
    }

    public function getStores()
    {
        return [
            new Local([
                "views" => __DIR__ . "/views",
                "store" => __DIR__ . "/docs",
            ]),
        ];
    }
}

$runner = new Runner();
$runner->run();

它是如何工作的？

分析器将读取文件并为此文件提供报告
存储将收集报告并将其保存到后端（html，nosql，sql ...）

注意

为了解析您的文件，rylai必须能够加载所有文件并执行它。这将导致扩展类可能存在一些问题
此库已在psr 4标准文件和文件夹下进行测试，如果您使用其他编码标准，请为其编写更多测试。
在解析标签内的类型别名（如Rylai\Fixtures\Items\Courier中的Courier）时存在问题，因此您必须将其与命名空间别名进行比较
到目前为止，常量无法具有docblock
本地存储将使用键-值路径，其中键是您的根命名空间，在此项目的情况下，您可以看到composer.json将Rylai\指向src文件夹

待办事项

将来将实现Elasticstore
将?标记替换为属性的值，因为有关私有属性的问题阻止解析器读取值
添加更多分析器

开发

运行测试

php vendor/phpunit/phpunit/phpunit

欢迎提交pull requests :)

haodt / rylai

维护者

详细信息

README

安装

用法

它是如何工作的？

注意

待办事项

开发