3

現在、いくつかの Ruby コードを文書化しています。「ホスト」と呼ばれるメソッドを持つ 2 つのクラスがあります。

これらのクラスの 1 つで、メソッドに特別なコメントが必要です。他のクラスでは、最初のクラスを参照し、その参照をそのクラスへのリンクにしたいと思います。

通常、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

#hostrdoc によって作成されたリンクは、このドキュメントのメソッドに直接戻るという役に立たないリンクです。

ありがとう！

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 に答える