ruby-on-rails - 如何使用Yard记录Rails枚举类型

Question

我有一个类似于ActiveRecord的类:

class User < ActiveRecord::Base

  # How do I document this?
  enum status [:registering, :active, :suspended, :deleted]
end

status属性用于构建状态机。如何使用yard记录该行代码？该文档需要包含 status属性及其所有可能状态的说明。

Answer 1

只需将所有选项列为逗号分隔的列表即可。

class User < ActiveRecord::Base

  # @!attribute [rw] status
  #   @return [:registering, :active, :suspended, :deleted]
  enum status [:registering, :active, :suspended, :deleted]
end

如果不确定类型定义，可以咨询 YARD Type Parser: