README

BumbleDocGen：PHP项目的文档生成器 🐝

BumbleDocGen 是一个强大的库，用于生成和维护大型和小型PHP项目代码旁边的文档。

此工具分析您的代码库，并生成一套全面的Markdown文档，包括类、方法和属性的描述，以及可导航的内部链接。

安装

使用以下命令将 BumbleDocGen 添加到您的项目 composer.json 文件中

 composer require bumble-tech/bumble-doc-gen

详细技术描述

💡 请参阅 项目的技术部分描述，了解所有类和方法的使用方法。

核心功能

• 🔍 解析: BumbleDocGen 通过解析PHP文件、提取注释并提供代码的详细模型来扫描您的项目。

• ✍️ 渲染: BumbleDocGen 使用模板生成Markdown内容，并用从解析代码中获得的数据填充这些模板。

• 🧠 文档生成的AI工具： BumbleDocGen 允许您使用一组AI工具来帮助生成项目文档。

如何使用

入口点

BumbleDocGen的界面主要由两个类组成： DocGenerator 和 DocGeneratorFactory。

• DocGenerator 提供了生成文档的主要操作。

  • addMissingDocBlocks()：此方法在您的代码中创建缺失的docBlocks。
  • fillInReadmeMdTemplate()：此方法使用预定义的模板准备 README.md 文件。
  • generate()：此方法生成所有必要的文档。
  • generateProjectTemplatesStructure()：此方法创建项目模板的结构。
  • parseAndGetRootEntityCollectionsGroup()：此方法解析您的项目文件并收集文档信息。

• DocGeneratorFactory 提供创建 DocGenerator 实例的方法。

  • create(configurationFiles: string)：此方法使用提供的配置文件创建一个 DocGenerator 实例。
  • setCustomConfigurationParameters(customConfigurationParameters: array)：此方法为 DocGenerator 创建设置自定义配置参数。

使用示例

1. 在PHP文件中处理库

require_once 'vendor/autoload.php';

use BumbleDocGen\DocGeneratorFactory;

// Initialize the factory
$factory = new DocGeneratorFactory();

// Create a DocGenerator instance
$docgen = $factory->create('/path/to/configuration/files');

// or $docgen = $factory->createByConfigArray([...]);

// Now call the desired operation
$docgen->generate();

1. 通过控制台应用程序处理库

# List of available commands
./vendor/bin/bumbleDocGen list

# Documentation generation example
./vendor/bin/bumbleDocGen generate -c <path to config file>

# Getting detailed information about a command
./vendor/bin/bumbleDocGen generate -h

此文档是使用Bumble文档生成器生成的，展示了其工作方式。

要更新此文档，请运行以下命令

 ./bin/bumbleDocGen generate