【Rails】メモ書きしたコメントを一括で見る機能

Posted at 2024-04-09

はじめに

アプリケーションコード内のコメントにtodoを書くことがあるのですが、実装途中に一覧で確認したい時があり、探したところ見つかりました！！

ご覧いただきありがとうございます!
この記事の投稿者は主にRuby on Railsを学習している初学者です。
理解不足な点や内容に誤りがございましたらご指摘いただけますと幸いです。

コメントに記入したtodoの内容は把握できているはずだが、見落としがないか一覧表示で確認したい。

コメントをアノテーション(注釈)として残しておく機能がRailsにありましたので、そちらを使っていきます。

使用方法は簡単です、コメントの記述方法を少しだけ追加します。

example_controller.rb

def example_action
  # TODO: 後でちゃんと実装してくださいね
  puts "hoge"
end

コマンドラインで下記コマンドを入力します、すると・・・

bin/rails notes

このような形で表示させることができます！
(カッコ内の数字は記述されている行番号です)

app/controllers/example_controller.rb:
  * [38] [TODO] 後でちゃんと実装してくださいね

アノテーションの種類ごとに絞り込むこともできるそうです。
上記のサンプルコードはTODOの例となります。
(実際に使用する際はそれぞれにきちんと用途があるため、確認した上で使用なさってください。)

bin/rails notes --annotation TODO
bin/rails notes --annotation FIXME
bin/rails notes --annotation OPTIMIZE

パッと確認する機能はないかなと思っていたところで見つかりました。
さすがRailsなんでもあるのか😳

実はこの記述、Railsガイドのrails routesコマンドの記述のすぐ近くにありました📓
こういった幅のある発見ができるのはドキュメント特有なのかなと感じます💡

オプションがたくさんある便利機能のようですが、実はポートフォリオ作成で余裕がなく見られていません😅
興味のある方はぜひご覧になってみてください。

最後までお読みいただき、ありがとうございました🙇