問題タブ [rdoc]

一連の Ruby メソッドがあり、それらの戻り値を書式設定されたレポートにダンプしたいと考えています。ただし、これらの結果に注釈を付けたい (つまり、値が何であるかを説明する) こともしたいと思います。各メソッドの既存のコメントを使用してこの注釈を付けることができるかどうか疑問に思っていました。

したがって、私がやりたいことは、通常どおり rdoc を出力することだと思いますが、各メソッドに対して実際には引数を指定してメソッドを実行します。引数はすべての単一メソッドで同じであるため、単純化されています。

これらのエラーはどういう意味ですか?

この

「yum install ruby​​-rdocs」を使用して rdocs をインストールしました。しかし、このエラーの意味がわかりません

たとえば、 と呼ばれるメソッドは常に見てきましたString#splitが、 はまったくString.split論理的ではないようです。または、の名前空間にいるString::splitと見なすことができるため、 . クラスが想定/暗示されている場合（ ）、メソッドだけを見たこともあります。#splitString#split

これが ri でのメソッドの識別方法であることを理解しています。どっちが先だった？

これは、たとえば、メソッドとフィールドを区別するためですか? また、これがインスタンス メソッドとクラス メソッドを区別するのに役立つと聞いたことがあります。しかし、これはどこから始まったのでしょうか?

複数の場所にいくつかの宝石をインストールしています。

生成/再生成する難しい/簡単な方法は何ですか:

• これらのインストールされたすべてのgemのrdocを一度に？
• これらのインストールされたすべての gem を一度に yardoc しますか?

Rails のインストールに使用gem install rails -v=2.3.8すると、rdoc と ri が生成されたと表示されます。

しかしgem server、私がブラウザでRailsドキュメントを開くことができないとき、それは言うdoc_root/rails-2.3.8/rdoc/index.html not found

を調べた/usr/local/lib/ruby/gems/1.8/doc/rails-2.3.8/rdocところ、空であることがわかりました。

修正方法は？gem で rdoc を生成するには?

私はrdoc 2.5.9を実行しており、実行するだけでデフォルトの「Darkfish」テンプレートでrdocを生成するとき:

私のレールルートフォルダーにあります。すべてのファイルが生成されますが、「images」および「js」フォルダーが doc ディレクトリにありません。したがって、手動でコピーする必要があります。

次のバージョンがあります。

これらのフォルダーをコピーするには、さらにコマンドライン引数を指定する必要がありますか?

gem をインストールするたびに、ri と rdoc が続きます。これがドキュメントであることは知っていますが、2つの違いと使用方法は何ですか?

Octopussyは次のように使用できます。

しかし、APIドキュメントhttp://rdoc.info/github/pengwynn/octopussy/master/Octopussyで「user」メソッドが見つかりません

ドキュメントによると、モジュールはSingleForwardableによって拡張されています。

そのモジュールにはメソッド「user」が含まれている必要がありますが、そのモジュールが見つかりません。

何故ですか？

私が間違っている場合は訂正してください。YARDはRDocと同じではありませんか?

それは RDoc に基づいているのではなく、完全に書き直したものですか?

YARD を使用している場合、RDoc を気にする必要はありませんよね?

私は現在、rubyソフトウェアのドキュメントを作成するためにrdocからyardに切り替えています。

私のドキュメントでは、コメントからいくつかのクラス/モジュールを参照することがよくあります。たとえば、次のようになります。

RdocはMysoft::Mypackage :: Utility :: Loggerクラスのドキュメントページへのリンクを正しく作成しますが、yardはタグを無視し、クラス名を単純な文字列と見なします。

yardに@seeタグがあることは知っていますが、これにより、ドキュメントに別の「関連項目」セクションが作成され、説明テキスト内でクラス/モジュールを参照する必要があります。

私は確かに何かが欠けていますが、これがヤードでどのように行われるべきかについての例があれば、私は本当に感謝します。

前進ごとに感謝します、

dl