我刚刚开始记录一个 rails 应用程序。我知道这实际上是由 rdoc 完成的，所以我遵循了一些关于语法等的 rdoc 指南，但是当我试图描述模型的属性、验证和模型之间的关系时，我陷入了困境，主要是因为这些东西是 ActiveRecord 的一部分。所以我想知道是否有一些关于如何记录 Rails 应用程序的指南或好的做法，或者我是否遗漏了什么？
我知道我可以把所有这些都放在类描述中，但我想知道是否有一种方法与声明本身(has_many、validates_presence_of 等)更紧密地联系在一起，属性呢？
最佳答案
我个人更喜欢 YARD - http://yardoc.org ，因为它在记录恕我直言方面做得更好。
我不知道是否有针对 Rails 的特定处理程序可用，但编写一个非常容易 - http://yardoc.org/guides/extending-yard/writing-handlers.html
一个很好的例子可能是属性处理程序 - yard gem 的一部分:
lib/yard/handlers/ruby/attribute_handler.rb
关于ruby-on-rails - 如何记录 Rails 应用程序？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/4074468/