3

我现在正在记录一些 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本文档中的方法。

谢谢！

4

1 回答 1

2

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

下面的例子就是你所描述的。

class A
  # first method
  def a
  end
end

class B
  # second method linking to A#a
  def a
  end
end
于 2011-06-27T11:34:17.633 回答