問題タブ [rdoc]

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ファイルにエラーがありません。

LionにアップグレードされたMacでバンドルアップデートを実行しようとしています。

次のエラーで、常にrdocのフェッチに失敗しています。

これは私が修正できるものである可能性が高いですか、それとも私がそれ自体を明確に見ることが期待できるrubygemsまたはrdocの問題ですか？

他のgemは正しくダウンロードおよびインストールされています。Gemfileでrdocを直接呼び出すことはありませんが、特定の（より低い）バージョンでrdocを追加しようとしましたが、同じエラーが発生します。からも同じエラーが発生しますgem install rdoc。

これが私のgemfileの内容です：

Rails 3.1.0.rc1、rc2、またはrc3を使用すれば、すべて問題ありません。しかし、スプロケットに問題があるようです（ここで参照）。Rails3.1.0rc5に移動することをお勧めします。それを（そしてrc4で）行おうとすると、rdocのフェッチに問題が発生します。rails 3.1.0rc5の代わりに、以前のリリースのスプロケットを使用することもできますが、私もそれがうまくいきませんでした。

LaTeX 形式で RDoc を生成することは可能ですか? RDoc と YARD を見ましたが、必要なものが見つかりませんでした。

Ruby のプロジェクトのドキュメントを LaTeX で書いていますが、API リファレンスを付録または章として、最終的な PDF に簡単に埋め込む方法が必要です。私にとって最も便利な方法は、Ruby ソース ファイルから LaTeX ソースを生成し、適切な場所にインクルードすることです。

実行時に ruby​​ コアと標準ライブラリのドキュメントを表示する方法はありgem serverますか?

rvm で作成されたコアおよび標準ドキュメントをナビゲートできますが、すべてのドキュメントを 1 か所にまとめたいと考えています。

を実行しましrvm docs [generate|generate-ri|generate-rdoc]たが、これらのコマンドのいずれも ruby​​gems にドキュメントを追加しませんでした。

Windowsで次のエラーが発生した場合の対処方法：

UPDATE2：Mysql サーバー5.5を使用しています。Libmqlファイルが/ libディレクトリーにあるので、そのファイルをruby/binとruby/libに貼り付けました。そしてcmdで私は同じ上記のエラーを受け取りました。

UPDATE1：これを再度実行すると、次のようになります。

C：\ work \ exchange2> geminstallmysql正常にインストールされたmysql-2.8.1-x86-mingw321gemがインストールされましたmysql-2.8.1-x86-mingw32のriドキュメントをインストールしています...

next_resultの定義がありません

field_nameの定義がありません

field_tableの定義がありません

field_defの定義がありません

field_typeの定義はありません

field_lengthの定義はありません

field_max_lengthの定義がありません

field_flagsの定義はありません

field_decimalsの定義はありません

time_inspectの定義はありません

time_to_sの定義はありません

time_get_yearの定義はありません

time_get_monthの定義はありません

time_get_dayの定義はありません

time_get_hourの定義はありません

time_get_minuteの定義はありません

time_get_secondの定義はありません

time_get_negの定義はありません

time_get_second_partの定義はありません

time_set_yearの定義はありません

time_set_monthの定義はありません

time_set_dayの定義はありません

time_set_hourの定義はありません

time_set_minuteの定義はありません

time_set_secondの定義はありません

time_set_negの定義はありません

time_set_second_partの定義はありません

time_equalの定義はありません

error_errnoの定義がありません

error_sqlstateの定義がありませんmysql-2.8.1-x86-mingw32のRDocドキュメントをインストールしています...

next_resultの定義がありません

field_nameの定義がありません

field_tableの定義がありません

field_defの定義がありません

field_typeの定義はありません

field_lengthの定義はありません

field_max_lengthの定義がありません

field_flagsの定義はありません

field_decimalsの定義はありません

time_inspectの定義はありません

time_to_sの定義はありません

time_get_yearの定義はありません

time_get_monthの定義はありません

time_get_dayの定義はありません

time_get_hourの定義はありません

time_get_minuteの定義はありません

time_get_secondの定義はありません

time_get_negの定義はありません

time_get_second_partの定義はありません

time_set_yearの定義はありません

time_set_monthの定義はありません

time_set_dayの定義はありません

time_set_hourの定義はありません

time_set_minuteの定義はありません

time_set_secondの定義はありません

time_set_negの定義はありません

time_set_second_partの定義はありません

time_equalの定義はありません

error_errnoの定義がありません

error_sqlstateの定義がありません

これが実際に可能かどうかはわかりませんが、app/modelsファイルにスコープのドキュメントを追加することで、Rails アプリのドキュメントをより完全なものにしようとしています。私がしようとしていることは次のとおりです。

そして、アプリで rdoc を実行すると、次のように文書化されるより伝統的なメソッドとともに、パブリック クラス メソッドとしてリストされていることを確認したいと思います。newest_records

編集

この質問は少し曖昧かもしれません。したがって、ここで明確にする試みがあります。現在、宣言の上にコメント行を追加しようとするとscope、RDoc によって生成されたスコープのドキュメントは取得されません。RDocがメタメソッド/属性を取得できることは知っています。そうしないと、で宣言されたドキュメントに属性が表示されませんattr_accessor。だから私の質問は、次のようにファイルにコメントを追加する方法です:

• このメソッドは、RDoc で生成されたドキュメントに表示されます
• パブリッククラスメソッドとして表示されます（パブリックインスタンスメソッドなどとは対照的に）

Rails (2.3.8) プロジェクトのドキュメントを生成したいと考えています。私が試したとき

標準の ruby​​ クラスを含むすべてのクラスと vendor ディレクトリ内のすべての ruby​​ ファイル (プラグインなど) のドキュメントを作成します。

次のディレクトリにあるルビークラス、ファイルのみのrdocドキュメントを作成するにはどうすればよいですか

1. app フォルダー (すべてのモデル、コントローラー、およびビュー)
2. 構成フォルダー
3. lib フォルダー