Have Geek Brain

Conventions for documentation of rails applications?

I knew this was more state-of-the-art than a technical question, but I am looking for good templates to document the model relationship, validation, method for models and controllers of my rails application.

Are there any conventions / examples / examples?

Thanks everyone for your help

+2


a source to share


1 answer


You can use RDoc to document your code yourself. This will require your code comments and documentation for your project.



It's pretty neat.

I'm not sure there is a lot to documenting validations and relationships ... Your Ruby source code is already incredibly readable in this regard.

0


a source






More articles:


All Articles