如何在Rails中为我的模型和控制器生成文档

6

我希望为我的应用程序的模型和控制器创建文档。即使是关于rake任务、任何后台作业的文档。因为代码中有成千上万行的注释,所以需要对所有函数和操作进行解释..

我不需要Rails的文档。

  rake doc:rails 

这对我来说毫无用处。

用例是内部详细的开发者笔记。


讽刺的是,我在这里搜索生成Rails文档的命令:) 非常感谢。 - Anwar
1个回答

12

尝试使用这个rake任务:

rake doc:app

这个任务由Rdoc提供。它还支持一些标记语言,可以在格式化时使内容更美观。您可以在文档中查看示例。


真棒...有没有第三方插件/gem可用于更好的文档编写?这个还可以,但我仍然希望有比这更好的东西。 - Mohit Jain
Rdoc是Rails的标准核心文档,您可以查看ERD以获取图形或YARD http://yardoc.org/。 - Devin M

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接