ruby - 如何使 rdoc 链接到带有等号的方法

Question

在一个文件中，我有

module Adapter
  ##
  # :method: avatar

  ##
  # :method: avatar=(value)
end

在另一个文件中，我想链接到这些方法：

# Adapter#avatar         # this generates a valid link to another page
# Adapter#avatar=        # this is shown as raw text

如何告诉 rdoc 它应该生成第二个链接？

更新：已确认如果作者是用 静态定义的def avatar=(value); end，则链接生成正常。动态作家虽然显然是错误的。

Update2：好的，这与链接无关。这是关于生成 writer 方法的正确名称：

module Adapter
  ##
  # :method: avatar=(value)
end

avatar=(value)()生成的带有名称的文档，以及

module Adapter
  def avatar=(value); end
end

生成链接的正确avatar=(value)文档。

Answer 1

您应该使用 声明您的参数:call-seq::method:，而不是在该行中包含您的参数列表。以下对我有用，所有链接都有效：

module Adapter
  ##
  # :method: avatar

  ##
  # :method: avatar=
  #
  # :call-seq: avatar=(value)
end

# See Adapter#avatar  
# See Adapter#avatar=
#
class Linked
end

:method:声明方法的名称，并:call-seq:声明它接受的参数签名。

（顺便说一句，我在这里找到了一些关于 RDoc 语法的非常有用的文档）。