[英]Rails RESTfull API Documentation
im searching for a Documentation Framework that supports the following features: 我正在搜索支持以下功能的文档框架:
I want to use it to document an RESTfull API i'm working on 我想用它来记录我正在使用的RESTfull API
I know about YARDoc, but would be nice to gather some alternatives 我知道YARDoc,但很高兴收集一些替代方案
Matt Silverman created a pretty comprehensive lists of what is available out there now for gen'ing docs from code. 马特·西尔弗曼(Matt Silverman)创建了一个相当全面的列表,列出了现在可以从代码生成文档的内容。
http://www.mattsilverman.com/2013/02/tools-to-generate-beautiful-api-documentation.html http://www.mattsilverman.com/2013/02/tools-to-generate-beautiful-api-documentation.html
Apart from YARD, you can generate RDOC project documentation using the following rake task: 除了YARD,您还可以使用以下rake任务生成RDOC项目文档:
rake doc:app
After this, your docs will be located in the doc/app
folder and can be viewed by opening the index.html
file in your browser. 之后,您的文档将位于
doc/app
文件夹中,可以通过在浏览器中打开index.html
文件进行查看。 It will include the (currently probably generic) doc/README_FOR_APP
file. 它将包含(当前可能是通用的)
doc/README_FOR_APP
文件。
Hope this helps :) 希望这可以帮助 :)
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.