我正在搜索支持以下功能的文档框架:
我想用它来记录我正在使用的RESTfull API
我知道YARDoc,但收集一些替代品会很好
答案 0 :(得分:1)
马特·西尔弗曼(Matt Silverman)创建了一个非常全面的列表,列出了现在可用于代码生成文档的内容。
http://www.mattsilverman.com/2013/02/tools-to-generate-beautiful-api-documentation.html
答案 1 :(得分:0)
除了YARD,您可以使用以下rake任务生成RDOC项目文档:
rake doc:app
在此之后,您的文档将位于doc/app
文件夹中,可以通过在浏览器中打开index.html
文件来查看。它将包括(当前可能是通用的)doc/README_FOR_APP
文件。
希望这会有所帮助:)