5
我想为我的应用程序的模型和控制器创建文档。即使是耙子任务，任何后台作业。由于我有成千上万的代码，解释所有的功能操作间内联注释行..如何为我的模型和控制器在rails中生成文档
我不想文档钢轨所以
rake doc:rails
是没用的我。
Usecase是内部详细的开发人员笔记。
A
回答
12
尝试使用这个rake任务：
rake doc:app
这个任务是由Rdoc提供，你可以看到这种类型的documentation here的样本。 它还支持一些标记，您可以使用它来使格式更好看，并且您可以看到一些examples here。
+0
真棒......是否有可用的好资料如有第三方插件/宝石。这一个很好，但我仍然喜欢有比这更好的东西。 –
+0
Rdoc是Rails的标准核心文档，您可以查看ERD的图表或YARD http://yardoc.org/。 –
2
上面的RDoc链接指向不再存在的SourceForge页面。 RDoc的新家在GitHub上。
相关问题
- 1. 如何在Rails 3.1.1.rc1中生成模型/控制器？
- 2. 如何为rails应用程序中的模型生成文档？
- 3. Rails 3为不支持表的模型生成控制器
- 4. Rails模型和控制器
- 5. 怎么Rails的生成，从我们的模型和控制器这条道路
- 6. 生成文档后从Word文档中删除控制控制
- 7. 如何在项目中重命名rails控制器和模型
- 8. 在rails控制器中保存文档
- 9. Rails在生成控制器，模型和视图方面的良好实践
- 10. Rails控制器如何访问模型？
- 11. 如何使我的控制器和模型在Rails中都可用？
- 12. rails中的控制器生成问题
- 13. 如何为我的Rails 3 REST服务生成公共文档？
- 14. rails rspec模型和控制器测试
- 15. Rails：如何在模型/控制器B中的视图中创建模型/控制器A中的项目？
- 16. 如何在Rails 3中为生成的模型启动slug mongoid_slug？
- 17. 如何让模型知道它的控制器在Rails中？
- 18. 在RoR中回滚生成的控制器/模型
- 19. Rails的：生成的控制器语法
- 20. 如何根据模型生成视图/控制器/测试
- 21. Yii2控制台代码生成器不生成查询模型
- 22. rails生成模型
- 23. 如何在Rails中为现有模型生成表单？
- 24. Rails - 在不同的控制器/模型中创建和编辑
- 25. rails belongs_to多个模型如何在控制器中创建
- 26. 如何生成我在C＃中编码为Xml的文档？
- 27. odoo auto在控制器中生成模型
- 28. 如何使用模型和控制器
- 29. 我如何在模型和/或控制器
- 30. 如何从控制器中的Rails 3调用模型方法？
反讽是，我在这里通过搜索产生轨文档的命令:)非常感谢你 – Anwar