概要
ソースコード中のコメントの
# TODO: 仕様に問題ないか確認する
のような記述の種類を調べてみた
なんだったか
# TODO のことをアノテーションコメントという
他にもあるの？
TODO以外にも色々あった。種類は以下の通り
| キーワード | 内容 |
|---|---|
| TODO | あとで追加すべき内容を表す |
| FIXME | 修正すべき箇所を表す |
| OPTIMEZE | パフォーマンスの最適化をすべき箇所を表す |
| HACK | リファクタリングすべき箇所を表す |
| REVIEW | レビューすべき箇所を記す |
アノテーションコメントの便利な使い方
Ruby on Railsの場合、アノテーションコメントが書かれた箇所を一覧で出力することができる
やり方(Ruby)
TODO,FIXME等を一覧で出力する- Ruby on Railsの場合
$ rake notesで一覧として出力 - それ以外 Gemのrake-notesを使用
- Ruby on Railsの場合
特定のアノテーションのみ表示する
$ rake notes:custom ANNOTATION=FIXME※独自のアノテーションも可能
file # DANGER: 注意$ rake notes:custom ANNOTATION=DANGERアノテーションの書き方
# + 半角スペース + アノテーション + 半角スペース + 本文
ex)
# TODO: ここを修正
参考サイト
ruby-style-guide Rails | コード内のコメントを見つける方法 (TODO、FIXME、OPTIMIZE、HACK、REVIEW)
