我刚开始记录一个rails应用程序.我知道这实际上是由rdoc完成的,所以我遵循一些关于语法的指南,但是当我尝试描述模型的属性,验证和模型之间的关系时,我被困住了,主要是因为这些东西是ActiveRecord的一部分.所以我想知道有没有一些指导或一个很好的做法,如何记录一个rails应用程序,或者是否有我缺少的东西？
我知道我可以将所有这一切都放在课堂描述中,但是我想知道是否有一种更接近于声明本身的方式(has_many,validates_presence_of等)以及属性呢？
解决方法
我个人更喜欢YARD –
http://yardoc.org,因为它更好地记录了IMHO.
我不知道是否有一个特定的Rails处理程序可用,但写一个 http://yardoc.org/guides/extending-yard/writing-handlers.html很容易 一个很好的例子可能是属性处理程序 – 院子gem的一部分： LIB /码/处理器/ruby/ attribute_handler.rb
我不知道是否有一个特定的Rails处理程序可用,但写一个 http://yardoc.org/guides/extending-yard/writing-handlers.html很容易 一个很好的例子可能是属性处理程序 – 院子gem的一部分： LIB /码/处理器/ruby/ attribute_handler.rb