ruby-on-rails - 使用 Yard 对 Rails 应用程序文档中的类进行分组

Question

是否有一个插件可以以对 Rails 应用程序有意义的方式格式化文档？

我一直在尝试使用 Yard，但它将所有 Model 和 Controller 类放在顶级命名空间下。有没有办法让它将它们视为模块，以便它们全部组合在一起？

我要采用的结构与 Rails 应用程序通常的结构相同，即

-Models
----ModelClass1
----ModelClass2
----ModelClass3
-Controllers
----ControllerClass1
----ControllerClass2
----ControllerClass3

但是 yard 文档生成器吐出的是

-ModelClass1
-ModelClass2
-ModelClass3
-ControllerClass1
-ControllerClass2
-ControllerClass3

标签： ruby-on-railsrubydocumentationyard

Answer 1

我有同样的目标，并在 YARD GitHub 上提出了一个问题。他们向我指出了使用自定义类列表菜单结构的 aws-sdk gem。我设法使用它来创建一个通用的 Rails 布局，大致模仿app/.

您可以在此要点的第 3 步下查看我的代码（如果您还没有创建模板目录结构，您可能需要备份到第 2 步）。