問題タブ [rdoc]

を使用して表示できるように、既存のコメントを「RDoc コメント」としてフォーマットしたいと考えていますri。

RDoc の使用を開始するための推奨リソースは何ですか?

OK、ペーパークリップ用の rDoc を生成しようとしていますが、rake タスクが到達する前に別のプラグインを詰まらせているため、これは問題外です:

壊れたプラグインを修正することもできますが、忙しくて怠け者なので、ペーパークリップのドキュメントを生成したいだけです。これを行う方法はありますか？

私はいくつかのメタプログラミングを使用して、次のようにrubyで一連のメソッドを生成しています。

'-A mood'を渡して、気分生成コードを属性として認識させることができることを知ってrdocいます。これは、少なくとも認識されるので便利です。

ただし、これらは実際には属性というよりも通常のメソッドに似ているため、を使用してドキュメントを見るときに、「属性：」セクションの下にリストされたくありませんri。私は通常の属性を持っていないので、このセクションのタイトルを「気分：」などに変更する簡単な方法はありますか？ユーザーは少なくとも入力するのに十分な好奇心がありri EmotionalObject#happyます。

RDoc で、一定のコメントを表示する方法はありますか? 私のプロジェクトで定数にコメントしたいのですが、それらがRDoc出力に表示されないことに気づきました。定数に関するコメントが含まれている可能性が高いドキュメントを確認しましたが、何も見ませんでした ( http://www.ruby-doc.org/core/classes/Math.html )。

自明であると仮定して、定数の横に実装を示すことは可能ですが、コメントも役立つようです。

それで、私は最近、たくさんの ruby​​ gem を書いています。便利だと思うことの 1 つは、現在のバージョン (gemspec で指定されている) を、私rdocのライブラリの で生成されたドキュメントと、使用される で生成されたセクションに含めることです。私のスクリプト（gem経由で配布しています）によって。ユーザーが現在使用しているライブラリ/スクリプトのバージョンを簡単に把握できるようにする方法。OptionParser--help

lib/またはbin/ディレクトリ内の ruby​​ ファイルから、gemspec で指定したバージョンにアクセスする方法はありますか? そうすれば、一度に複数の場所を更新する必要はありません-gemspecだけです。

現在、私は自分の gemspec を手作業で生成していますが、まだ Rake トレインには乗っていません。rubygems が提供するものだけで直接やりたいことを実行できない場合、rake または別のツールでこれを実行できますか?

help2man と txt2man を介して「--help」出力を使用して man ページを生成するのが好きです。Ruby の RDoc システムは非常に便利ですが、RDoc::usage を思い通りに構成できないようです。サンプル スクリプトを次に示します。

スクリプトの出力は次のようになります。

しかし、使用方法の出力用に「名前」ヘッダーと「概要」ヘッダーを抑制したいのですが、マニュアル ページへの出力用のセクションとしてマークします。

':section:' マークアップの使用は RDoc::Rdoc では機能しますが、RDoc::usage では機能しません。ヘッダーを印刷せずに、usage.rb のセクションをマークする明確な方法はありますか?

hannaテンプレートを使用してRuby ドキュメントを生成したいと考えています。

どうやってするか？または、入手できる場合はどこでダウンロードできますか?

使用する

rdoc -o ~/doc --inline-source --line-numbers --format=html --template=hanna

メソッドが欠落しているドキュメントを教えてくれます。Cで書かれたメソッドを生成しないようです。

最近、Mac OS X (バージョン 1.0.1) に同梱されているものを置き換えるために、Ruby gems を介して RDoc バージョン (2.4.3) をインストールしました。残念ながら、コマンド ラインで run "rdoc" を呼び出すと、まだ RDoc 1.0.1 しか使用できません。rdoc -v の戻り値:

最初のエントリが RDoc 2.4.3 フォルダーを指すように $PATH 変数を修正しようとしましたが、うまくいきませんでした。こちらもネットで調べてもわからなかったのでこちらで質問させていただきました。

乾杯！

アップデート：

" " を実行するとgem list -d --version 1.0.1 rdoc、以下が返されます。

したがって、RDoc の Mac OSX バージョンが Gems バージョンに干渉していることは間違いありません。

更新 2:

私は以下を使用して見つけました：

古いバージョンの RDoc が /opt/local/bin にあったことを確認します。それを削除し、gems ディレクトリを $PATH に追加しました

これで、最新の RDoc の新しい作業コピーができました!

Ioke doc では、ISpec テストがドキュメントに含まれています。ioke.org/dok/index.html を参照してください。

これは、Ruby の RSpec と RDoc (または SDoc) でどのように行うことができますか? そのためのコマンドライン スイッチや外部ライブラリが見つかりません。アイデアはありますか（すべて自分で実装することは含まれません;-)）？

私は Apache/passenger でいくつかの rails/rake アプリを実行していgem serverます。これらのアプリに によって提供されるドキュメンテーション アプリを追加したいので、docs.example.org のような特別な (サブ) ドメインを簡単に与えることができます。私たちのチームのすべてのメンバーが簡単に利用でき、誰も自分でサーバーを起動したり、ポート番号 (デフォルトのgem serverポートである 8808 など) を覚えたりする必要はありません。