kosuha606/minidoc

此包最新版本（1.0.13）没有可用的许可信息。

Minidoc

维护者

详情

github.com/kosuha606/minidoc

源代码

问题

安装: 441

依赖: 0

建议者: 0

安全: 0

星标: 2

关注者: 1

分支: 0

开放问题: 0

1.0.13 2020-04-14 09:42 UTC

Requires

Requires (Dev)

Unknown License 4e3b5173a2266cb26bfd586ff7307179500b2d67

  • Eugene Kosuhin <kosuha606.woop@gamil.com>

This package is auto-updated.

Last update: 2024-09-29 05:55:29 UTC

README

安装

$ composer require --dev kosuha606/minidoc

快速开始

一个用于从项目中的类注释快速收集文档的工具。

文档输出示例

<?php
echo (new DocsBuilder())
    ->addParseParam('category')
    ->addParseParam('description')
    ->addParseParam('version')
    ->addClassRegexp('/classes/')
    ->addPreloadClassesDir(__DIR__.'/classes')
    ->buildTemplate()
;

工作示例

alt text

配置

向模板添加样式或脚本

$docsBuilder->addStyle(new ResourceDTO(__DIR__.'/resources/style.css', ResourceDTO::TYPE_FILE));
$docsBuilder->addScript(new ResourceDTO(__DIR__.'/resources/script.js', ResourceDTO::TYPE_FILE));

渲染自定义文档模板

$docsBuilder->setViewTemplate(__DIR__.'/views/main.php');

在注释中添加自己的解析参数

$docsBuilder->setParseParams(['category', 'description']);
$docsBuilder->addParseParam('mark');

通过传递类所在的目录路径来设置类的前置加载

$docsBuilder->addPreloadClassesDir(__DIR__.'/../../../../contexts');

在构建后处理数据

$docBuilder->afterBuildData(function() {});

为指定目录设置选择文件的正则表达式

$docBuilder->setFilesRegexp();

选择输出语言或指定语言文件

$docBuilder->setLanguage('ru');
// Или указать свой массив переводов
$docBuilder->setTranslations(require_once __DIR__.'/ch.php');

变更日志

1.0.13 (2020-04-14)

  • 修复缓存重置错误

1.0.12 (2020-04-14)

  • 修复 setCacheFile 方法

1.0.11 (2020-04-14)

  • 添加了方法注释的解析

1.0.10 (2020-04-14)

  • 修正了与 composer 外部包的绑定

1.0.9 (2020-04-11)

  • 添加了国际化支持
  • 添加了缓存和缓存重置功能