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

我正在寻找类似RDoc的东西，它将与Sinatra很好地合作。除常规Sinatra路由外，它还需要能够处理通过“register MyModule”从外部加载的路由，其形式如下：

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

跟我一起去。从yard的主页：

您可以在YARD中编写各种扩展，包括那些可以理解您的框架在其自己的小Doman特定语言（dsl）中所做的所有动态魔法的扩展。最重要的是，这真的很容易做到！已经有一些插件支持诸如RSpec、DataMapper、Sinatra之类的框架，对其他插件的支持也在进行中

这里似乎有一个插件：它至少已经完成了一些您想要的功能

---

祝你好运

我只是想指出，从v0.7.0开始，Yard就在本地支持Sinatra路线，所以您不再需要Yard Sinatra了

---

您可以在

上找到更多信息，您正在尝试制作哪种文档？您希望记录应用程序的哪些方面？只是路线？路由接受的参数？为什么源代码中的注释不够？基本上与RDoc的用例相同。我希望显示名称、描述和参数——示例使用将是一个额外的好处。现在注释在源代码中，但是我想自动生成单独的HTML程序员文档。我必须

gem安装yard-yard-sinatra

（目前分别为0.9.16和1.0.0），并使用

yard-plugin-yard-sinatra