Help us understand the problem. What is going on with this article?

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

More than 5 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 見つける」でググってもヒットしなかったのでメモ。
Yinaura
https://twitter.com/yumainaura / mv here http://qiita.com/Yumainaura / yumainaura / 稲浦悠馬 / いなうらゆうま
https://twitter.com/yumainaura
Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away