rails app文档的约定？

Question

我知道它更像是一种艺术状态，而不是技术问题，但我正在寻找一些好的模板来记录我的rails应用程序的模型和控制器的模型关系，验证，方法。

是否有任何惯例/最佳实践/示例？

感谢大家的帮助

Answer 1

您可以使用RDoc自行记录代码。它将为您的项目提供代码注释和文档。

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

非常整洁。

我不确定在记录验证和关系方面有多大用处......在这方面，您的Ruby源代码已经非常易读。