modelやcontorollerで
hogecontroller.rb
#TODO
などのようにアノテーションコメントを記述して、ターミナルで
$ rake notes
と叩くと、ソースコードの中のTODOと書いた場所を探して、表示してくれます。
modelやcontorollerのファイルでは#TODOでコメントアウトすればもちろん問題なく表示されるのですが、view(html.erb)で
hoge.html.erb
<!-- TODO -->
のように記述すると、rake notesと叩いても検索してくれません。
その時の記述は,
<% #TODO ここを直す %>
のように記述しましょう。
ちなみに他にも下記のようなアノテーションコメントを使用できます。
| キーワード | 内容 |
|---|---|
| TODO | 不足している時 |
| FIXME | 修正するべき箇所 |
| OPTIMIZE | 最適化するべき箇所 |
| HACK | リファクタリングするべき箇所 |
| REVIEW | レビューするべき箇所 |