annotate-models

→ ‘annotate-models’

What

Installing

  sudo gem install annotate-models

The basics

Add a comment summarizing the current schema to the top of each ActiveRecord model source file.

This was created by Dave Thomas as a Rails plugin. This is now a gem that can run from command line

Demonstration of usage

Go to your project dir (RAILS_ROOT), then run: annotate

To remove annotations: annotate -d

To add annotations at the end of files: annotate -p after

How to submit patches

See Using Git within a project

The trunk repository is http://github.com/ctran/annotate_models

A svn mirror is on rubyforge svn://rubyforge.org/var/svn/annotate-models/trunk

License

This code is free to use under the terms of the MIT license.

Contact

Comments are welcome. Send an email to Cuong Tran

Cuong Tran, 2nd May 2008
Theme extended from Paul Battley