Railsでカラムにコメントをつけたいときはマイグレーションファイルを作って追加する

Railsでカラムに説明を追加したいときは、マイグレーションファイルから追加すると幸せになれるというお話です。

Railsのマイグレーションファイルではchange_column_commentというAPIで特定カラムにコメントを追加することができます。

class AddCommentToTable < ActiveRecord::Migration[7.1]
  def change
    change_column_comment :table_name, :column_name, from: '', to: '追加したいコメント'
  end
end

fromとtoオプションをつけないとDBをロールバックできなくなるので注意してください。
今回は新たにコメントを追加する想定なので、fromオプションには空文字を設定しています。