【问题标题】:Document class_attribute with yard带有 yard 的文档 class_attribute
【发布时间】:2015-02-21 21:58:49
【问题描述】:

如何告诉 yard 记录使用 Rails 的class_attribute method 设置的类属性?目前它只是忽略它们。

一个例子:

class Base
  class_attribute :defaults

  self.defaults = { foo: 'bar' }
end

【问题讨论】:

  • 普通的attr标签不行吗? # @attr [Hash] defaults The default values of something
  • 不,这似乎不会触发任何文档。我在想我需要为 YARD 写一个扩展

标签: ruby-on-rails ruby yard


【解决方案1】:

我发现使用group tag 是一个很好的解决方案

# @!group Class Attributes
# @!attribute [rw]
# Stores some value
class_attribute :my_atttribute
# @!endgroup

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2014-10-15
    • 1970-01-01
    • 2014-09-26
    • 2012-02-21
    相关资源
    最近更新 更多