ruby – 使用Yardoc记录def_delegators

发布时间：2020-12-16 19:12:15 所属栏目：百科来源：网络整理

导读：我有一个使用 Forwardable模块中的def_delegators方法的类.我还没有找到一种方法来获取 Yardoc输出文档.我已经尝试使用 macro,但它不会为这些特定方法输出任何内容(文件中的其他内容都很好,并且没有错误),并且我有几个不同长度的def_delegator. 例如 class A

我有一个使用 Forwardable模块中的def_delegators方法的类.我还没有找到一种方法来获取 Yardoc输出文档.我已经尝试使用 macro,但它不会为这些特定方法输出任何内容(文件中的其他内容都很好,并且没有错误),并且我有几个不同长度的def_delegator.

例如

class A
  extend Forwardable
  # other code…

  # @!macro
  #   @see Array#$1
  #   @see Array#$2
  #   @see Array#$3
  def_delegators :@xs,:size,:<<,:blah # …

如果有人知道宝石或这样做的方式,这意味着我可以避免尝试写一个Yard扩展来做到这一点,我会非常感激.

解决方法

经过更多的实验,我发现这很有效：

# @!method size
  #   @see Array#size
  # @!method <<
  #   @see Array#<<
  # @!method blah
  #   @see Array#blah
  def_delegators :@xs,:blah # …

很可能有一种方法可以在一行或两行中完成,但与编写扩展的工作相比,我发现这是非常可接受的.

更新：

我刚刚发现这将更好地链接到委派方法的文档：

# @!method size
  #   @return (see Array#size)

这将采用Array#size方法中已记录的返回值.我希望其他标签也会这样做.它仍然非常冗长,但可以接受.

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!