我应该用什么来记录我的 Sinatra 路线？答案

【问题标题】：What should I use to document my Sinatra routes?我应该用什么来记录我的 Sinatra 路线？
【发布时间】：2013-04-17 10:59:08
【问题描述】：

我正在寻找可以与 Sinatra 很好地配合使用的 RDoc 之类的东西。除了常规的 Sinatra 路由之外，它还需要能够处理通过“register MyModule”从外部加载的路由，格式如下：

Module MyModule
  def self.registered(app)
    # Description of someroute.
    app.get '/someroute' do

【问题讨论】：

【解决方案1】：

使用yard。来自 yard 的主页：

您可以在 YARD 中编写各种扩展，包括那些可以理解您的框架在其自己的小型域特定语言 (DSL) 中所做的所有动态魔法的扩展。最重要的是，它真的很容易做到！已经有插件支持 RSpec、DataMapper、Sinatra 等框架，并且正在开发对其他框架的支持。

这里似乎有一个插件：https://github.com/rkh/yard-sinatra，它至少可以完成您想要的一些功能。

祝你好运！

【讨论】：

【解决方案2】：

我只是想指出 Yard 从 v0.7.0 开始就原生支持 Sinatra 路由，因此您不再需要 yard-sinatra。

【讨论】：

遗憾的是，我没有发现这种情况。我不得不gem install yard yard-sinatra（目前分别是0.9.16和1.0.0）并用yard --plugin yard-sinatra调用