phpdoc-md 项目教程

phpdoc-md 项目教程

phpdoc-mdPHPDocumentor Markdown generator项目地址:https://gitcode.com/gh_mirrors/ph/phpdoc-md

1. 项目的目录结构及介绍

phpdoc-md 项目的目录结构如下：

phpdoc-md/
├── bin/
│   └── phpdoc-md
├── src/
│   ├── Console/
│   │   └── Command/
│   │       └── GenerateCommand.php
│   ├── Parser/
│   │   └── PhpDocParser.php
│   ├── Renderer/
│   │   └── MarkdownRenderer.php
│   └── PhpDocMd.php
├── tests/
│   └── PhpDocMdTest.php
├── composer.json
├── LICENSE
└── README.md

目录结构介绍

• bin/: 包含可执行文件 phpdoc-md，用于运行命令行工具。
• src/: 包含项目的源代码。
  • Console/: 包含命令行相关的类。
    • Command/: 包含具体的命令类，如 GenerateCommand.php。
  • Parser/: 包含解析 PHPDoc 注释的类，如 PhpDocParser.php。
  • Renderer/: 包含生成 Markdown 文档的类，如 MarkdownRenderer.php。
  • PhpDocMd.php: 主类文件，负责协调解析和渲染过程。
• tests/: 包含测试文件，如 PhpDocMdTest.php。
• composer.json: Composer 配置文件，用于管理依赖。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件是 bin/phpdoc-md。这是一个可执行的 PHP 脚本，用于启动 phpdoc-md 工具。

启动文件内容

#!/usr/bin/env php
<?php

require __DIR__ . '/../vendor/autoload.php';

use Evert\PhpDocMd\Console\Command\GenerateCommand;
use Symfony\Component\Console\Application;

$application = new Application();
$application->add(new GenerateCommand());
$application->run();

启动文件介绍

• 第一行是 Shebang 行，指定使用 PHP 解释器来执行该脚本。
• require __DIR__ . '/../vendor/autoload.php'; 引入 Composer 自动加载文件。
• use Evert\PhpDocMd\Console\Command\GenerateCommand; 引入生成命令类。
• use Symfony\Component\Console\Application; 引入 Symfony Console 应用类。
• new Application() 创建一个新的 Symfony Console 应用实例。
• $application->add(new GenerateCommand()); 添加生成命令到应用中。
• $application->run(); 运行应用。

3. 项目的配置文件介绍

项目的配置文件是一个 PHP 文件，通常命名为 phpdoc-md.php，位于项目根目录中。

配置文件示例

<?php

return (object)[
    'rootNamespace' => 'Clean\PhpDocMd\Example',
    'destDirectory' => 'docs',
    'format' => 'github',
    'classes' => [
        '\Clean\PhpDocMd\Example\Basic',
        '\Clean\PhpDocMd\Example\Deep\Foo',
        '\Clean\PhpDocMd\Example\ExtendClass',
        '\Clean\PhpDocMd\Example\ExtendExtendClass',
    ],
];

配置文件介绍

• rootNamespace: 指定项目的根命名空间。
• destDirectory: 指定生成的 Markdown 文档的输出目录。
• format: 指定生成的文档格式，如 github。
• classes: 指定需要生成文档的类列表。

通过以上配置，phpdoc-md 工具将根据指定的类和配置生成相应的 Markdown 文档。

phpdoc-mdPHPDocumentor Markdown generator项目地址:https://gitcode.com/gh_mirrors/ph/phpdoc-md