ruby-on-rails - rails : how to add comment on fields?

Question

我找到了一段代码，谁能告诉我comment:主要用来做什么，如何给表名和字段添加注释？

我使用 PostgreSQL。

  create_table "sun", force: :cascade, comment: "The center" do |t|
    t.string   "distance",                     comment: "Long way"
    t.string   "energy",                       comment: "Super power"
    t.datetime "created_at",  null: false
    t.datetime "updated_at",  null: false
  end

Answer 1

在 Rails 5 中，您可以在数据库迁移中为表、列和索引指定注释。这些评论存储在数据库本身中。您正在查看显示评论的 schema.rb。

目前只有 MySQL 和 PostgreSQL 支持添加评论。

评论只是评论 - 它们给出了表/列的简短摘要。

要在迁移期间添加评论，您只需将 comment: 'This is an explanatory comment' 添加到迁移中，显然替换您想要的评论文本。

这显示在下面的示例迁移中，我在其中向表添加列:

class AddSomethingToSometable < ActiveRecord::Migration
  def change
    add_column :sometable, :something, :integer, comment: 'This is an explanatory comment'
  end
end

有关详细信息，请参阅 original pull在 GitHub 上