問題タブ [rdoc]

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

Ruby でコマンドを実行するgem serverと、マシンにインストールしたすべての gem のドキュメントの Web ページが表示されます。すべてのローカル rdoc ドキュメントが 1 つの簡単にアクセスできる場所にあるように、ローカル ドキュメントに対して同様のことを行うことはできますか? アドバイスをいただければ幸いです。

使用しているクラスにこのメソッドがあります

パラメータのドキュメントでは、def binary_search(array, key)ではなくとして表示されますbinary_search(a,x)。ドキュメント修飾子を使用しようとしましたが# :binary_search: array, key、成功しませんでした。私はこれについて少し知っていますが、実際のソースコードとは異なるドキュメントのパラメーターを作成する方法を誰かが知っている場合は、教えてもらえますか? ありがとう。

Darkfish RDocジェネレーターを使用してRDocドキュメントを生成する場合、メソッドのClick to toggle source横に各メソッドの横にボタンがあります。ドキュメントを生成するときに機能しません。その機能をどのように機能させるのですか。RDocソースなどにキーワードを追加する必要がありますか？

新しい宝石を開発するときは、宝石商の宝石を使用しています。スケルトンの一部として、RDoc 関連の rake タスクのセットをセットアップします。主なタスクはrake rdoc. Rakefile からわかる限り、このタスクはrake/rdoctaskライブラリを使用して、RDoc コメントから HTML ドキュメントを生成します。

RDoc コメント内のクラスとメソッドへの参照をインテリジェントに作成しようとします。しかし、たとえば というメソッドがあるため、RDoc ジェネレーターuserを記述するたびに、このメソッドを参照していると見なされます。RDoc マニュアルuser(「Documenting Source Code」の最後) によると、これは単語の前にバックスラッシュ (\) を付けることで無効にできます。\user

しかし、私の場合、これはうまくいきません。完成した HTML ドキュメントにバックスラッシュを出力するだけで、その単語を相互参照として使用します。

これを機能させる方法について何か考えはありますか？

適切なRDoc構文の優れた確実なリファレンスを探しています。推奨事項？はっきりとわかるものが見つからないようです。

1. クラスメソッドとそのパラメータを文書化する方法
2. クラスまたはクラスメソッドの機能を文書化する方法。

rdoc を使用して Ruby プロジェクトのドキュメントを作成している最中に、darkfish の rdoc フォーマッタを発見しました。とても気に入っていますが、:call-seq:タグが機能しなくなりました。代わりに、リテラル文字列:call-seq:をドキュメントに配置し、呼び出しシーケンス自体をコード ブロックとしてフォーマットします。コードから :call-seq: ブロックのすべてを削除したくはありません。ドキュメントの多くは、:call-seq:ブロックで指定されたインスタンス名とパラメーター名を参照する必要があるためです。他の誰かがこの問題を抱えていますか? どうすればいいですか、回避策はありますか? 私はかなり確信しています:call-seq:タグは、デフォルトのフォーマッタを使用していた以前は機能していましたが、元のフォーマットの生成に戻る方法がわからないため、確信が持てません (files 以外の引数を指定せずに rdoc を呼び出すと、darkfish 出力が生成されるようになりました。 doc フォルダーを削除します!) これを修正する方法を知っている人はいますか?

Railsアプリケーションのドキュメントを作成し始めました。これは実際には rdoc によって行われることを知っているので、構文などに関していくつかの rdoc ガイドに従いましたが、モデルの属性、検証、およびモデル間の関係を記述しようとしたときに行き詰まりました。主に、これらは ActiveRecord の一部であるためです。Railsアプリケーションを文書化する方法に関するガイドや良い習慣があるのだろうか、それとも私が欠けているものがあるのだろうか?

これらすべてをクラスの説明に入れることができることはわかっていますが、宣言自体 (has_many、validates_presence_of など) にもっと密接に結び付いた方法があるのではないかと思います。属性はどうですか?