conventions for rails app documentation? [closed]
开发者_运维百科
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 4 years ago.
Improve this questionI known that it's more a state of art than a technical question, but I'm looking for some good templates to document model relation, validations, method for the models and controllers of my rails app.
Are there any conventions/best practice/examples to do that ?
Thanks all for your help
You can use RDoc to self-document your code. It'll take your code comments and make documentation for your project.
- http://rdoc.rubyforge.org/
- http://en.wikibooks.org/wiki/Ruby_Programming/RubyDoc
It's pretty neat.
I'm not sure there's much use in documenting validations and relations... Your Ruby source code is already incredibly readable in that regard.
精彩评论