ruby - 我应该用什么来记录我的 Sinatra 路由？

Question

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

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

Answer 1

选择yard .来自院子的主页:

You can write all kinds of extensions in YARD, including ones that can understand all of the dynamic magic your framework does in its own little Doman Specific Languages (DSLs). Most importantly, it's really easy to do! There are already plugins that support frameworks like RSpec, DataMapper, Sinatra, and support for others are in the works.

这里好像有个插件:https://github.com/rkh/yard-sinatra这至少可以满足您的一些需求。

祝你好运!