我有一个类似于ActiveRecord的类:
class User < ActiveRecord::Base
# How do I document this?
enum status [:registering, :active, :suspended, :deleted]
end
status
属性用于构建状态机。如何使用yard记录该行代码?该文档需要包含status
属性及其所有可能状态的说明。
最佳答案
只需将所有选项列为逗号分隔的列表即可。
class User < ActiveRecord::Base
# @!attribute [rw] status
# @return [:registering, :active, :suspended, :deleted]
enum status [:registering, :active, :suspended, :deleted]
end
如果不确定类型定义,可以咨询YARD Type Parser:
关于ruby-on-rails - 如何使用Yard记录Rails枚举类型,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/33453605/