Rails Source Code Annotations March 4, 2007

Posted by Slobodan Kovacevic in : Ruby & Rails , trackback

Ruby On Rails
I’ve been catching up on my blog reading and I’ve stumbled upon an article describing a great new feature in Edge Rails that lets you add annotations to your code. You can use TODO, OPTIMIZE and FIXME to mark parts of your code. Then you can use rake notes to list annotations - which is great since you won’t miss any of the notes you made.

The only problem is that this is still in only in Edge Rails, i.e. it’s not yet in stable Rails release. But there’s a really simple way to add source code annotations rake task to non-Edge Rails app:

svn export http://svn.rubyonrails.org/rails/trunk/railties/lib/tasks/annotations.rake \
 lib/tasks/annotations.rake

For more information about Rails source code annotations see Ryan’s blog.

Comments»

1. Cheat Codes » Rails Source Code Annotations - March 4, 2007

[…] Original post by Slobodan Kovacevic and a wordpress plugin by Elliott […]