README

此包提供为您应用程序的调度生成自动文档的功能

安装

运行命令

composer require artarts36/laravel-schedule-documentator

php artisan vendor:publish --provider="ArtARTs36\LaravelScheduleDocumentator\Providers\LaravelScheduleDocumentatorProvider" --tag=config

简单生成

$generator = app(\ArtARTs36\LaravelScheduleDocumentator\Services\DocGenerateHandler::class);

$generator->handle('md', '/path/to/file.md');
$generator->handle('json', '/path/to/file.json');
$generator->handle('csv', '/path/to/file.csv');

控制台命令

支持的格式

安装

运行：composer require artarts36/laravel-schedule-documentator
将LaravelScheduleDocumentatorProvider添加到提供者
运行：php artisan vendor:publish --tag=schedule_doc

添加自定义格式

创建新的Documentator（通过合约\ArtARTs36\LaravelScheduleDocumentator\Contracts\Documentator）
将"extension/documentator"条目添加到config/schedule_doc.php中的"ext_documentator"字段

    [
        'ext_documentator' => [
            // other documentators
            'zip' => MyZipDocumentator::class,
        ],
    ]

命令描述

为了完整文档，必须填写控制台命令的description属性。

使用PHP CS Fixer规则 PhpCsFixerGoodFixers/laravel_command_no_empty_description来防止未描述的命令进入您的仓库。

artarts36 / laravel-schedule-documentator

维护者

详细信息