代码之家 › 专栏 › 技术社区 › ramontiveros

如何记录Rails应用程序?

rdoc activerecord ruby-on-rails

10

ramontiveros · 技术社区 · 15 年前

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

我知道我可以把所有这些都放在类描述中,但是我想知道是否有一种方法与声明本身更紧密地联系在一起(是否有许多,验证存在等),以及属性如何?

2 回复 | 直到 15 年前

1

3

Roman 15 年前

http://yardoc.org http://yardoc.org/guides/extending-yard/writing-handlers.html

2

Andrew Atkinson 15 年前