如何使用TomDoc语法记录YARD中的config_accessor方法？

Question

我正在处理包含ActiveSupport的可配置模块的代码，我正在尝试记录配置访问器。

有人知道如何在YARD Tomdoc中这样做吗？

我尝试了以下内容，但它似乎没有在文档中呈现任何内容。

class MyConf

  include ActiveSupport::Configurable

  # Is this configuration awesome? (defaults: true)
  config_accessor(:is_awesome) { true }

end

Answer 1

这有效！

class MyConf

  include ActiveSupport::Configurable

  ##
  # Is this configuration awesome? (defaults: true)
  config_accessor(:is_awesome) { true }

end