соглашения для документации по приложениям rails?

Question

Я знал, что это более современное состояние, чем технический вопрос, но я ищу хорошие шаблоны для документирования отношений модели, валидации, метода для моделей и контроллеров моего приложения rails.

Есть ли какие-либо соглашения/примеры/примеры для этого?

Спасибо всем за вашу помощь

Answer 1

Вы можете использовать RDoc самостоятельно документировать свой код. Это потребует комментариев вашего кода и документации для вашего проекта.

• http://rdoc.rubyforge.org/
• http://en.wikibooks.org/wiki/Ruby_Programming/RubyDoc

Это очень аккуратно.

Я не уверен, что для документирования валидаций и отношений много смысла ... Ваш исходный код Ruby уже невероятно читабельен в этом отношении.