当我们置身于一个庞大的项目之中时,往往会有那么片刻的茫然和不知所措,不知道下一步该做什么,不知道该在哪些地方施展拳脚。这时候 rake notes
这个铁轨自带的小工具就显得尤为的重要,它会搜寻项目中的注释代码,找到包含 TODO, FIXME, OPTIMIZE
的注释区域,告诉你在哪个文件的第几行。
rake notes
默认寻找 TODO, FIXME, OPTIMIZE
(注意:这里注释中的关键字必须是大写字母,使用小写字母将会被忽视;当然在关键字后无缝插接其他内容也是会被找到的)
# search by all three types
➜ rake notes
app/models/application_record.rb:
* [3] [TODO] finish it soon...
app/models/user.rb:
* [5] [TODO] write some other code...
* [6] [FIXME] some bugs need to be fixed...
* [7] [OPTIMIZE] you can do it better :D ...
# search by individual way
➜ rake notes:todo
➜ rake notes:fixme
➜ rake notes:optimize
# search by custom way
➜ rake notes:custom ANNOTATION=BIS