Rails
migration

Rails | コード内のコメントを見つける方法 (TODO、FIXME、OPTIMIZE、HACK、REVIEW)

More than 3 years have passed since last update.

$ rake notes

で、プロジェクト内のアノテーションコメントを一覧表示してくれる。

例:

app/models/example.rb:

* [ 10] [TODO] モデルにカラムを追加する

app/models/example.rb:
* [ 4] [FIXME] create が動かない


特定のアノテーションだけ表示する

たとえば

$ rake notes:custom ANNOTATION=FIXME

と書けば FIXME だけを見つけてくれる。


独自のアノテーションを見つける

文字列で検索しているだけなので。

独自のアノテーションも見つけられる。


file

# DANGER: 注意!


$ rake notes:custom ANNOTATION=DANGER


アノテーションの書き方

# + 半角スペース + アノテーション + 半角スペース + 本文 

という形式で書くこと。

例:

# FIXME: ここを修正する


補足


  • Rails 標準なので gem のインストールは必要ない。

  • 「Rails FIXME 見つける」でググってもヒットしなかったのでメモ。