一个 API 文档生成器
Sami: API 文档生成器 ====================================== 警告:Sami 不再受支持和维护。欢迎 fork。想了解 Sami 生成的内容吗?请查看 Symfony API_ 安装 -------------------- .. caution::
Sami 需要 PHP 7。
获取 Sami 为 phar 文件_:
.. code-block:: bash
作为普通 Composer 依赖项安装 Sami 并不受支持。Sami 是一个工具,而不是库。因此,它应作为一个独立的包安装,这样 Sami 的依赖项就不会与您项目的依赖项相冲突。
实际上,除了目录之外,您还可以使用任何有效的 PHP 迭代器(同样,也可以使用 Symfony Finder 类的任何实例):
.. code-block:: php
return new Sami($iterator, array( 'theme' => 'symfony', 'title' => 'Symfony2 API', 'build_dir' => DIR.'/build', 'cache_dir' => DIR.'/cache', 'remote_repository' => new GitHubRemoteRepository('username/repository', '/path/to/repository'), 'default_opened_level' => 2, )); 以下是如何配置不同版本的方法: .. 代码块:
暂无开放 Issues,或尚未同步最近议题。