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:好的，这与链接无关。这是关于生成编写器方法的正确名称:

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 语法的非常有用的文档 here )。