Question

我正在记录一些ruby代码。我们有两个类都有一个名为“host”的方法。

在其中一个类中，该方法需要一些特殊注释。在另一个类中，我想引用第一个类，并将该引用作为它的链接。

通常在rdoc中，键入方法名称就足以生成链接。在这种情况下，即使我写出Class::SubClass.host，链接仍然坚持指向当前类中的方法。

任何rdoc大师都知道如何做到这一点？

以下是FakeTown::Api中我想要链接到RealTown::Api方法#host的示例：

# Returns the host as defined in config.yml under the heading "url".
# 
# It appears as though this method is no longer in use, as
# features/support/vcr_config.rb contains its own method
# by the same name which directly references RealTown::Api#url
def host
  uri = URI.parse url
  uri.host
end

rdoc生成的链接无效地链接回本文档中的#host方法。

谢谢！

Answer 1

您可能希望链接到实例方法，而不是类方法。 Class::SubClass#host应该有用。

以下示例执行了您所描述的内容。

class A
  # first method
  def a
  end
end

class B
  # second method linking to A#a
  def a
  end
end

链接到不同类中的同名方法（Rdoc）

1 个答案: