如何使用Yard记录继承构造函数

Question

有课程，如：

class Foo
  def initialize(data)
  end
end

class Bar < Foo
end

从Foo继承的每个子类都有自己的唯一属性，这些属性通过data选项散列传递。

Bar的码输出如下：

Constructor Details
This class inherits a constructor from Foo

我还没有弄清楚如何记录Bar#initialize的选项。

这些努力包括：

class Bar < Foo
  # @overload initialize(data)
  #   @param data [Hash]
  #   @option data [String] :baz Value for baz attribute
end

(什么也不做)

class Bar < Foo
  # @param data [Hash]
  # @option data [String] :baz Value for baz attribute
  # @!parse def initialize(data); end
end

(创建一个显示假方法的“视图源”的无文档构造函数)

class Bar < Foo
  # @!parse
  #   @param data [Hash]
  #   @option data [String] :baz Baz attr
  #   def initialize(data); end
end

(不做任何事情，结果与上面的@overload相同)

如何使用庭院记录子类的选项？

Answer 1

试着把这个和院子一起用。和红宝石版本2.6

class Foo
  def initialize(data)
  end
end

class Bar < Foo
  # @overload initialize(data)
  # @param [String] data list
  # def initialize()
  # end
end

并检查生成的class_list.html文件。

在Linux发行版上测试过。

如果有任何其他技术问题，或者您需要一个定制的Ruby文档解决方案作为临时措施。