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

Question

I want to create docs for the models and controller of my application. Even for rake task, any background job. As I have thousands of lines of comments inline between the code, explanation of the all the functions actions..

I don't want docs for rails so

  rake doc:rails 

is useless for me.

Usecase is internal detailed developer notes.

Answer 1

Try using this rake task:

rake doc:app

This task is provided by Rdoc . It also supports some markup that you can use to make things look better when formatted. You can see examples in the documentation .

Answer 2

The RDoc links above point to SourceForge pages which no longer exist. The new home for RDoc is on GitHub.

https://github.com/rdoc/rdoc