Как генерировать документы для моих моделей и контроллера в рельсах

Question

Я хочу создать документы для моделей и контроллеров моего приложения. Даже для граблей, любой фоновой работы. Поскольку у меня есть тысячи строк комментариев между кодом, объяснение всех функций действий.

Я не хочу документы для рельсов, поэтому

  rake doc:rails 

для меня бесполезен.

Usecase - это внутренние подробные заметки разработчика.

Answer 1

Попробуйте использовать эту задачу rake:

rake doc:app

Эта задача предоставляется Rdoc , и вы можете увидеть образец документации такого типа здесь .Он также поддерживает некоторую разметку, которую можно использовать для улучшения внешнего вида при форматировании, и вы можете увидеть примеров здесь .

Answer 2

Ссылки RDoc выше указывают на страницы SourceForge, которые больше не существуют. Новый дом для RDoc находится на GitHub.

https://github.com/rdoc/rdoc