README

自动为单个PHP类或项目目录内的所有类生成静态开发者文档。主题化，允许以任何方式轻松地定制结果，并支持基本的HTML、Markdown和Syrus格式。

生成的文档示例

类：https://apexpl.io/docs/classes/svc/convert/

方法：https://apexpl.io/docs/classes/svc/convert/case

安装

使用Composer安装

composer require apex/docs-generator

使用方法

为单个类生成文档

use Apex\Docs\docsGenerator;

/ Set some variables
$class_name = "App\\MyPackage\\Controllers\\OrderController";
$dest_dir = "/path/to/docs/order_controller";
$base_uri = "/docs/";

// Generate single class
$generator = new DocsGenerator();
$generator->generateClass($class_name, $dest_dir, $base_uri, 'html');

generateClass()函数的最后一个参数是要使用的主题。所有主题都可以在安装目录的/themes/目录中找到，默认支持三个主题 - html, markdown, syrus

上述操作将在/path/to/docs/order_controller创建一个空目录，并在其中创建一个index.html文件，列出该类中的所有方法，每个方法都链接到另一个特定方法页面。

**为PHP类目录生成文档**

use Apex\Docs\docsGenerator;

/ Set some variables
$source_dir = "/path/to/my_package";
$dest_dir = "/path/to/docs/";
$base_uri = "/docs/";
$base_namespace = "App\\MyPackage\\";

// Generate directory
$generator = new DocsGenerator();
$generator->generateDirectory($source_dir, $dest_dir, $base_uri, $base_namespace, 'html');

这将遍历$source_dir内的所有文件和目录，并为每个找到的PHP类生成一个新的文档目录。它还会在每个包含PHP类的根命名空间中生成必要的索引页面，概述该命名空间中的所有类。

Syrus集成

如果你希望使用Syrus，内置了支持。如果你希望使用此集成并且在使用Syrus以外的Apex中，要启用集成，请打开/config/container.php Syrus文件并查找项

syrus.tag_namespaces

在此数组中，添加条目

Apex\\Docs\\SyrusTags

这就完成了。在生成文档时，只需将$theme参数从"html"更改为"syrus"，它就会生成针对Syrus格式化的文档。

Apex

由Apex框架提供，链接：https://apexpl.io/.

apex/docs-generator

维护者

详细信息

README

安装

目录

使用方法

Syrus集成

Apex