問題タブ [yard]

私は、さまざまな言語で何年も使用してきたdoxygenの大ファンです。特に、画像を含め、Graphviz ドット ジェネレーターを実行して、インライン DOT コードまたは外部ファイルから任意のインライン ダイアグラムを作成できる wiki のような機能を高く評価しています。

RDocには、Graphviz を使用してクラス図を生成するためのダイアグラム サポートがありますが、任意の画像や図を含める方法がわかりません。また、酸素のような任意のページの構築もサポートしていないようです。

これらの Doxygen スタイルの機能を Ruby に提供するツールはありますか?

ツールのRuby Toolboxリストをざっと調べたところ、それらはすべてRDocのバリアントのようです。

現時点で私にとって最も可能性の高い解決策は、Yard を拡張することです。

YARD ドキュメントにいくつかのリンクを作成しようとしています。HTTP リンクを取得できます。

としてレンダリングします

しかし、電子メールのリンク:

私に警告を与える：

そして次のようにレンダリングします

リンクの通常の RDoc 構文を試しました。

しかし、YARDはそれを無視しているようです。より信頼性の高い構文を知っている人はいますか?

私はYARDをとても楽しんでいました:

http://www.ootl.org/yard/

http://code.google.com/p/yardparser/

http://www.codeproject.com/KB/recipes/yard-tokenizer.aspx

完全に機能する電卓を構築することができました。PHPパーサーを実行するためにYARDを評価しています。PEG文法とパーサージェネレーターの制限について親切にアドバイスしてください。どうもありがとうございました！

私は自分の Rails プロジェクトでYARDを使用していますが、Rails モデルで継承されたメソッドやランタイム メソッドをどのように文書化するのだろうかと考えていました。たとえば、モデルのfirst_name属性の存在を文書化します。User

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

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

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

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

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

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

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

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

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

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

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

前進ごとに感謝します、

dl

Yard を使用してドキュメントを生成し始めたばかりで、モデルとコントローラーではうまく機能しますが、ビュー用に何も生成できないようです

私はそれを機能させるためにさまざまな方法を試しました。現在、このようなドキュメントを生成するためのrakeタスクをセットアップしました

そこの最後のパスには、私のビューを含める必要があると思いますが、ドキュメントを見ると、これらのファイルについてはまったく言及されていません。理由はありますか？

乾杯

RDoc には :include: タグ (このページの下部を参照) があり、任意のテキスト ファイルを取り込んで、インクルードが始まる場所でインデントされているかのようにフォーマットします。これは、ドキュメントの例のソース コードを取り込むのに最適な方法です。

Yardにも同様のタグや機能がありますか?

私は、./lib/extensions/ に配置された拡張機能に分割する中規模の Sinatra アプリを作成しています。各ルートを文書化したいのですが、Yard::Sinatra はメインの application.rb ファイルで定義されたルートのみを文書化します。何かを行うために Yard::Sinatra を構成できますか? それとも、独自のプラグインを作成する必要がありますか?