列挙型の

Question

レールを文書化するためにヤードを使用するにはどのように私はこれに似たActiveRecordのクラスを持っている：

class User < ActiveRecord::Base 

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

status属性は、状態マシンを構築するために使用されます。ヤードを使用してその行のコードを文書化するにはどうすればよいですか？ドキュメントには、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に相談することがあります。より良い答えがないために、あなたに授与さ