约定Rails应用程序的文档？

Question

我知道，这是更多的艺术不是技术问题的状态，但是我正在寻找一些好的模板，文档模型的关系，验证，方法，模型和我的Rails应用程序的控制器。

是否有任何约定/最佳做法/例子来做到这一点？

感谢所有您的帮助

Answer 1

您可以使用RDoc的自我书写代码。它会把你的代码注释并为你的项目制作文档。

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

这是非常整洁。

我不知道有一个在记录验证和关系......你的Ruby源代码已经在这方面令人难以置信的可读多大用处。