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

发布时间：2020-12-16 23:20:30 所属栏目：百科来源：网络整理

导读：我有一个类似于这样的ActiveRecord类： class User ActiveRecord::Base # How do I document this? enum status [:registering,:active,:suspended,:deleted]end status属性用于构建状态机.如何使用码文件记录该行代码？文档需要包含状态属性及其所有可能状

我有一个类似于这样的ActiveRecord类：

class User < ActiveRecord::Base

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

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

解决方法

class User < ActiveRecord::Base

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

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!