elefant/app-visor

Visor 是 Elefant CMS 的 API 文档浏览器

维护者

详细信息

github.com/jbroadway/visor

源代码

问题

安装: 23

依赖: 0

建议: 0

安全性: 0

星标: 4

关注者: 2

分支: 0

公开问题: 0

类型:elefant-app

1.0 2012-08-16 13:36 UTC

Requires

MIT 2092101ed28eb55c3466adda6bf968de4c6ba930

documentationapicmsdocReferenceappelefantlibrariesclasses

This package is auto-updated.

Last update: 2024-08-28 07:01:54 UTC

README

这是一个为 Elefant CMS 设计的非常简单的文档生成器。它使用 PHP 的反射类从 Elefant 的核心类生成类似 JavaDoc 风格的输出。

这并不是要完全替代 phpDoc 或 ApiGen，而是一个更易于集成到我们网站中的简单解决方案。

我写这个的原因有几个

  • 我不喜欢新 phpDoc 输出的“交互式”元素
  • 我经常遇到 ApiGen 代码生成的问题，并且他们的 Texy 标记比 Markdown 差
  • 我想使用比两者都更人性化的注释格式
  • 使用 PHP 的反射功能，文档生成既容易又有趣

要查看此应用程序的使用示例，请访问

http://api.elefantcms.com/

为了使路由正常工作，请在 conf/routes.php 中的 [Alias] 部分添加以下内容

/api = /visor
/helpers = /visor/helpers
/helper = /visor/helper