Wie Yard verwenden, zu dokumentieren Schienen Aufzählungstyp

Question

Ich habe eine Klasse Active ähnlich wie diese:

class User < ActiveRecord::Base 

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

status Attribut verwendet wird, eine Zustandsmaschine zu bauen. Wie dokumentiere ich diese Codezeile mit Yard? Die Dokumentation muss das Attribut status und alle möglichen Zustände enthalten.

Answer 1

class User < ActiveRecord::Base 

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

Answer 2

Listen Sie einfach alle Optionen als durch Komma getrennte Liste auf.

class User < ActiveRecord::Base 

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

Wenn Sie nicht sicher Typdefinition sind, können Sie mit YARD Type Parser konsultieren: