Ruby on rails 3 Rails REST完整的API文档_Ruby On Rails 3_Api_Documentation_Yard

Ruby on rails 3 Rails REST完整的API文档

ruby-on-rails-3 api documentation

Ruby on rails 3 Rails REST完整的API文档,ruby-on-rails-3,api,documentation,yard,Ruby On Rails 3,Api,Documentation,Yard,我正在搜索支持以下功能的文档框架：由代码注释生成可搜索样式可定制 N：链接引用（如果我在某处引用一个类，则类名应该链接到类文档）我想用它来记录我正在开发的RESTfull API 我知道YARDoc，但如果能收集一些备选方案，那就太好了。除了YARD之外，您还可以使用以下rake任务生成RDOC项目文档： rake doc:app 之后，您的文档将位于doc/app文件夹中，可以通过在浏览器中打开index.html文件来查看。它将包括（目前可能是通用的）doc/README\u

我正在搜索支持以下功能的文档框架：

由代码注释生成
可搜索
样式可定制
N：链接引用（如果我在某处引用一个类，则类名应该链接到类文档）

我想用它来记录我正在开发的RESTfull API

我知道YARDoc，但如果能收集一些备选方案，那就太好了。除了YARD之外，您还可以使用以下rake任务生成RDOC项目文档：

rake doc:app

之后，您的文档将位于

doc/app

文件夹中，可以通过在浏览器中打开

index.html

文件来查看。它将包括（目前可能是通用的）

doc/README\u FOR\u APP

文件

希望这有帮助：）

除了YARD，您还可以使用以下rake任务生成RDOC项目文档：

rake doc:app

之后，您的文档将位于

doc/app

文件夹中，可以通过在浏览器中打开

index.html

文件来查看。它将包括（目前可能是通用的）

doc/README\u FOR\u APP

文件

希望这能有所帮助：）

马特·西尔弗曼（Matt Silverman）创建了一个非常全面的列表，列出了现在可以从代码生成文档的内容

谢谢，真的很有用：）谢谢，真的很有用：）