garrcomm / markdown-generator

类文档生成器

维护者

详细信息

bitbucket.org/garrcomm/markdowngenerator/

主页

源代码

问题

文档

安装: 10

依赖: 1

建议: 0

安全性: 0

v1.x-dev 2023-05-22 14:18 UTC

Requires

Requires (Dev)

CC-BY-SA-4.0 e30f4e928159d720f34e08ded10a64fec0e822e5

markdown

This package is auto-updated.

Last update: 2024-09-22 17:37:46 UTC

README

对于我的代码项目，我喜欢提供适当的文档。在我看来，最好的方法是从编写良好的文档的代码开始。

为了根据代码库生成Markdown格式的文档，我编写了这个小型工具。

它使用PHP反射来读取代码信息，并按照php.net文档中使用的结构进行格式化。

生成的文档示例可以在https://bitbucket.org/garrcomm/php-uuid/src/v1/README.md找到。

如何使用

使用非常简单；

  1. 使用Composer安装此包；
    composer require garrcomm/markdown-generator --dev
  2. 创建一个配置文件（示例在https://bitbucket.org/garrcomm/php-uuid/src/v1/.mdgen.json）；
  3. 执行生成器；
    vendor/bin/mdgen mdgen.json