Как документировать приложение rails ?

Я только начал документировать приложение rails. Я знаю, что на самом деле это делается с помощью rdoc, поэтому я следовал некоторым руководствам по rdoc, касающимся синтаксиса и так далее, но я застрял, когда пытался описать атрибуты моделей, проверки и отношения между моделями, в основном потому, что эти вещи являются частью ActiveRecord. Поэтому мне интересно, есть ли какое-нибудь руководство или хорошая практика относительно того, как документировать приложение rails, или есть что-то, что я ' m отсутствует?

Я знаю, что могу поместить все это в описание класса, но мне интересно, есть ли способ, более тесно связанный с самим объявлением (has_many, validates_presence_of и т. д.) и как насчет атрибутов?

10
задан zetetic 2 November 2010 в 05:18
поделиться