あとあと見返した際に、これなんだって時などに使うのがアノテーションというそうです。
コードに# TODOなどと書いておくと後で一括で抽出できるので、リリース前とかに確認すると良いかもですね。
# controller
class ApplicationController < ActionController::Base
# TODO コントラーラーです。
def show_image
end
end
# model
class Message < ApplicationRecord
belongs_to :topic
# TODO モデルです。
end
# view
<% #TODO ビューです %> #<%=とするとダメっぽいです。
<div class="row">
<h1>テスト</h1>
</div>
$ rails notes
app/controllers/application_controller.rb:
* [4] [TODO] コントラーラーです。
app/models/message.rb:
* [4] [TODO] モデルです。
app/views/topics/new.html.erb:
* [1] [TODO] ビューです
それぞれの単語の意味は、こんな感じだそうです。
- TODO:やらなければならないこと
- FIXME:ここ誰か直して
- OPTIMIZE:最適化が必要
参考にさせていただいたサイト
https://permanent-til-me.ssl-netowl.jp/archives/1184