It’s pretty amazing. It’s also pretty weird that it’s not inside Rails already. Maybe it is? Anyway, if you are tired of going to your schema.rb to check out your tables structures, you should read about this plugin and use it. It does exactly what you want it to do. It adds documentation to your model classes about your tables structures.
For someone coming from the Java world, used to having Javadoc in each one of the business/model classes, it is awesome to have. It makes you feel like just the syntax changed, when you look at your model classes.
annotate-models for practical rails
Tired of going to schema.rb to find your table structures information? Get the annotate-models plugin for documenting your model classes!
I just found the annotate-models gem the other day, after reading a chapter of this book:
Enterprise Recipes with Ruby and Rails
Also, I found this clear explanation about the usage of the gem:
http://ruby.geraldbauer.ca/rails-annotate-activerecord-models.html
It’s pretty amazing. It’s also pretty weird that it’s not inside Rails already. Maybe it is? Anyway, if you are tired of going to your schema.rb to check out your tables structures, you should read about this plugin and use it. It does exactly what you want it to do. It adds documentation to your model classes about your tables structures.
For someone coming from the Java world, used to having Javadoc in each one of the business/model classes, it is awesome to have. It makes you feel like just the syntax changed, when you look at your model classes.