Last Updated: February 25, 2016
·
280
· jazminschroeder

View code comments in your terminal

class MyClass

    #TODO: complete this method
    def complete_me
    end

    #FIXME: fix this method
    def fix_me
    end

    #OPTIMIZE: optimize this method
    def optimize_me
    end

end

In you terminal
$ rake notes
app/models/myclass.rb:
* [2] [TODO] complete
thismethod
* [3] [FIXME] fix
thismethod
* [4] [OPTIMIZE] optimize
this_method

Filter each comment type with rake notes:todo, rake notes:fixme or rake notes:optimize.

Create your custom comment types with rake notes:custom ANNOTATION=JAZNOTE