Ruby on RailsでTODOコメントの一覧を抽出する方法


システム開発を行うときに、「やらなければならないこと」の備忘録としてTODOコメントを残す場合があります。

また、「ここ誰か直して」の意味でFIXME、パフォーマンスが悪い箇所で、最適化が必要なものをOPTIMIZEを使う場合もあります。

忘れずに製品リリースまでにこれらのコメントでの対応箇所をすべて消化できればよいのですが、たいてい書いた本人ですら忘れます。

そこで、「TODOコメントが書いてある箇所を一斉に抽出する方法はないのだろうか?」と思ったらありました。

bundle exec rake notes

このコマンドを実行することで、

# TODO:
# FIXME:
# OPTIMIZE:

のコメントの一覧を抽出することができます。

FIXMEやOPTIMIZEを抽出せず、TODOコメントだけ抽出する場合は、

bundle exec rake notes:todo

を使います。(同様の要領で、FIXME、OPTIMIZEのみの抽出も可能)

これで、「うっかりFIXME残したまま製品リリースしちまったぜ!」というミスを無くすことができますね。