約定Rails應用程序的文檔？

Question

我知道，這是更多的藝術不是技術問題的狀態，但是我正在尋找一些好的模板，文檔模型的關係，驗證，方法，模型和我的Rails應用程序的控制器。

是否有任何約定/最佳做法/例子來做到這一點？

感謝所有您的幫助

Answer 1

您可以使用RDoc的自我書寫代碼。它會把你的代碼註釋併爲你的項目製作文檔。

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

這是非常整潔。

我不知道有一個在記錄驗證和關係......你的Ruby源代碼已經在這方面令人難以置信的可讀多大用處。