如何记录rails应用程序?

ram*_*ros 10 activerecord ruby-on-rails rdoc

我刚刚开始记录rails应用程序.我知道这实际上是由rdoc完成的,所以我遵循了一些关于语法的rdoc指南等等,但当我试图描述模型的属性,验证和模型之间的关系时,我陷入困境,主要是因为这些东西都是ActiveRecord的一部分.所以我想知道是否有一些关于如何记录rails应用程序的指南或良好实践,或者是否有我遗漏的东西?

我知道我可以把所有这些都放在类描述中,但是我想知道是否有一种方法与声明本身(has_many,validates_presence_of等)更紧密地联系在一起,那么属性呢?

Rom*_*man 3

我个人更喜欢 YARD - http://yardoc.org,因为它在记录方面做得更好。我不知道 Rails 是否有可用的特定处理程序,但编写一个很容易 - http://yardoc.org/guides/extending-yard/writing-handlers.html 一个很好的例子可能是属性处理程序 -院子宝石的一部分:lib/yard/handlers/ruby/attribute_handler.rb