如何使用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

  # @attr [Enumerable<Symbol>] status
  enum status [:registering, :active, :suspended, :deleted]
end

Answer 2

只需以逗号分隔列表的形式列出所有选项。

class User < ActiveRecord::Base

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

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