問題タブ [rdoc]

ri / rdocファイルを持たないgemがいくつかありますが、このrdocファイルをインストールする方法があるかどうか知りたいです。

Ruby on Rails 3.0.7 を使用しており、 RDocシステムのしくみを理解しようとしています。したがって、公式ドキュメントが7行目でそれを参照している場合、「ハッシュ」値が何を意味するのかを理解したいと思います:

1. クラス、ソース ファイル、およびアンダースコアを含むかハッシュ文字が前に付いたメソッド名の名前は、 コメント テキストからそれらの説明に自動的にハイパーリンクされます。

コメントされたコードでそれを述べる例を教えてもらえますか? その使い方について何かアドバイスはありますか？

ところで：RDocを参照する「MUST READ」リソースはありますか？もしそうなら、あなたはそれを提供できますか？

Ruby on Rails 3.0.7を使用していますが、アプリケーションを文書化したいと思います。そのためには、 RDocに関する「優れた」ドキュメントを見つける必要があります。

どこで見つけることができますか？つまり、RDocに関するドキュメントを見つけるための「最良の」Webリソースは何ですか？

私は Ruby on Rails 3.0.7 を使用しており、RDocを使用してアプリケーションのドキュメントを作成しています。Web 上で例を含む優れたドキュメントを見つけられなかったので、私が知りたいのは、:include:ディレクティブの使用方法です。

アプリケーションファイルでそれを使用する例を教えてもらえますか?

Ruby on Rails 3.0.7 を使用しており、RDoc を使用してアプリケーションのドキュメントを作成しています。私のアプリケーションファイルには次のものがあります：

私のアプリケーションのドキュメントを生成すると、上記のコメント付きのコードは、それらが表示されるはずの段落ブロックの外に出class User < ActiveRecord::Baseてしまいます。end

以下は、関連するスクリーン ショットです。

どうすれば解決できますか？

これを使用すると、同じ出力（クラスステートメントが表示される段落ブロックの外側）が得られます

またはこれ

RDoc を使用して、Ruby on Rails 3.0.7 アプリケーションのドキュメントを作成しています。アプリケーションlibフォルダーには、次のものがあります。

#'CONSTANT' documentation text上記のコードのドキュメントを生成しようとすると、RDoc は と を解析しない#'method_name' documentation textため、出力ドキュメントは空白になります。

1. モジュール「コンテキスト」内のコメント化されたコードを RDoc で考慮するにはどうすればよいですか?

:doc:次のようにディレクティブを使用しても役に立ちません。

Class\Module Indexにこれらがあることに注意してください。

2. どういう意味ですか?

YAMLファイルをドキュメント化するためのjavadocやrdocのようなものがありますか？それをHTMLドキュメントに抽出できますか？理想的にはマークダウン構文を使用します。

RVMをインストールしたばかりで、TheWell-GroundedRubyistの本を読んでいます。最初の章ではri String#upcase、upcaseメソッドに関するドキュメントを表示しようとしていますが、次のようなメッセージが表示されます。

String＃upcaseについては何も知られていない

SOに関するいくつかの投稿を見つけました。これは、おそらくRDocがインストールされていないためだと言っています。しかし、私はそれを修正する方法を理解していません。

MacOSX10.6と最新のRVMを使用しています。AppleのDeveloperキットに付属している標準のRubyインタープリターに加えて、1.9.2のみをインストールしました。

Rails 3プラグインを作成していて、エンジンを使用しています。プラグインにコントローラー、モデル、ビューを含むapp/フォルダーがあります。

問題は、RDocを使用してドキュメントを生成する場合、app/フォルダーに移動してそこにあるファイルを解析しないことです。それらを検索する場所がわかるように、渡す必要のあるオプションはありますか？

rvmをインストールしてから、次のコマンドで3.1rc5をレールします。

しかし、「riドキュメントのインストール」とRDocドキュメントの後にいくつかのエラーが発生しました。

READMEファイルの問題は大した問題ではないようですが、「lib」ファイルが見つからないのは少し怖いようです。なぜそうしているのですか？gem install rdoc一部の検索では、他の人がこの問題を抱えており、それを修正してから再実行していることが明らかになりましたgem install rails --pre。しかし、それでも同じlibファイルにエラーがありません。