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

Moh*_*ain 5 documentation ruby-on-rails ruby-on-rails-3

我想为我的应用程序的模型和控制器创建文档.即使是rake任务,任何后台工作.因为我在代码之间有几千行注释,所有函数动作的解释.

我不想要有关于rails的文档

  rake doc:rails 
Run Code Online (Sandbox Code Playgroud)

对我来说没用.

Usecase是内部详细的开发人员注释.

Dev*_*n M 12

尝试使用此rake任务:

rake doc:app
Run Code Online (Sandbox Code Playgroud)

此任务由Rdoc提供,您可以在此处查看该类型文档的示例.它还支持一些标记,您可以使用这些标记在格式化时使事情看起来更好,您可以在这里看到一些示例.