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

Question

我正在寻找类似RDoc的东西，它可以与Sinatra一起使用。除了常规的Sinatra路由之外，它还需要能够处理通过“注册MyModule”和外部形式加载的路由：

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

Answer 1

使用yard。来自院子的主页：

  

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

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

祝你好运！

Answer 2

我只是想指出Yard自v0.7.0开始就支持Sinatra路线，所以你不再需要yard-sinatra了。

您可以在https://github.com/lsegal/yard/wiki/SinatraRoutes

找到更多信息