模型注解 annotate

模型注解

虽然不是必须的，不过你会发现使用 annotate 注解一下 Rails 模型是很有用的。

把 annotate 加入 Gemfile

gem 'annotate'

然后执行 bundle install 命令安装：

$ bundle install

安装后就得到一个名为 annotate 的命令，可以在模型文件中加入一些注释，说明数据模型的结构：

$annotate 

注解后的模型文件如代码所示。

app/models/user.rb

# == Schema Information
#
# Table name: users
#
# id :integer not null, primary key
# name :string(255)
# email :string(255)
# created_at :datetime
# updated_at :datetime
#
class User < ActiveRecord::Base
  attr_accessible :name, :email
end

注意，如果要保持注解的时效性，每次修改数据模型后都要执行 annotate 命令。