Rails Guide 読んでたら notes
というタスクがあるのを知りました。
コードのコメントに TODO
とか FIXME
, OPTIMIZE
といったコメントをみつけて表示してくれます。
grep すればいいや
とか思いますが、それなりの便利そうです。jenkins なんかで回してレポートに出すのもよいかもしれません。
$ roke notes
app/controllers/admin/users_controller.rb:
* [ 20] [TODO] any other way to do this?
* [132] [FIXME] high priority for next deploy
app/model/school.rb:
* [ 13] [OPTIMIZE] refactor this code to make it faster
* [ 17] [FIXME]
notes:custom
というタスクもあるようです。
もう少しつっこんでみよう
タスクのソースコードがここになります。
notes:custom
では 環境変数 ANNOTATION で表示するキーワードを決められるようです。
notes
の場合は “OPTIMIZE”, “FIXME”, “TODO” の3つか使用されていますね。
あと 動的にタスクを生成しているようなのでnotes:todo
optimize
fixme
といったタスクも存在するようです。