問題タブ [yard]

YARD の readmeには、 YARDraw dataによって生成されたという記述があります。

YARD はまた、文書化されたオブジェクトを生データ (ダンプされた名前空間) として出力します。これをリロードして、後で生成したり、コードを監査したりすることもできます。これは、開発者が生データを使用して、たとえば YAML などの任意のカスタム形式の出力生成を実行できることを意味します。

raw dataを使用して他の形式に変換する例/ブログ/チュートリアルは何ですか? たとえば、生データの一部を YAML に変換することに興味があります。

YARDを使用してrubyクラスメソッドへのリンクをどのように作成しますか？リンクに関するヤードのドキュメントは次のとおりです。

同じ名前空間内のインスタンスメソッドへのリンク：

これは問題なく動作します。ただし、クラスメソッドを使用した同じアプローチに従うと、コンパイルおよび変更は行われません。

次のプレーンテキスト（リンクではない）を生成します。

gem をインストールする場合でも、ヤード単位で rdoc を完全に置き換える方法はありますか?

今のところ、gem serverrdoc で生成されたドキュメントにしかアクセスできません。FFI-gem のようないくつかのケースでは、ドキュメンテーションは yard で書かれており、rdoc で生成されたドキュメンテーションを読み込もうとするのgem serverは非常に苦痛です。

rdocをヤードに置き換える可能性はありますか

Forwardableモジュールのdef_delegatorsメソッドを使用するクラスがあります。Yardocにドキュメントを出力させる方法が見つかりませんでした。マクロを使用してみましたが、これらの特定のメソッドに対しては何も出力されません (ファイル内の他のすべては問題なく、エラーはありません)。また、長さが異なるものがいくつかあります。def_delegators

例えば

誰かが宝石やこれを行う方法を知っていれば、これを行うためにヤード拡張を作成しようとすることを避けることができます.

Gherkin スクリプトをローカライズするために#language:ru、各 .feature ファイルの一番上にコメントを追加し、ステップとシナリオにローカライズされた名前を使い始めました。

ただし、このコメントは、yard-cucumber プラグインを使用してスクリプトを文書化した後、結果の html ドキュメントに残ります (機能名のすぐ下に表示されます)。またfeatures/category_info.feature:3、各背景/シナリオ ブロックの後に次のような行を追加します。デバッグモードの一部ですか？「yardoc -c」コマンドを使用してドキュメントを作成すると、yard-cucumber プラグインが自動ロードされます。

何か不足していますか？庭でこれらのアーティファクトを省略するにはどうすればよいですか?

次の DSL の YARD プラグインの作成に問題があります。

ここで、DSL によって「影響を受ける」これらのメソッドのドキュメント スニペットにメモを追加したいと思いますmy_dsl。ハンドラー内でmy_dslは、スコープはまったく異なります (新しいドキュメントを追加したくありません。既存のメソッドを拡張したいのです。)

そのため、内部でProxyコード オブジェクトを使用MyDSLHandler#processして、後で後処理を遅らせるために必要なメソッドをマークすることにしました (これは、組み込みのMethodHandleron内で発生しdef do_it ; … ; endます)。

問題は、オブジェクトがからではなく、Proxyプレーンから派生しているため、メソッドが定義されていないことです。ObjectYARD::CodeObjects::Base[]=

オブジェクトの実際のインスタンス化中に使用できるように、現在のコンテキストからProxyオブジェクトにいくつかの値を保存するにはどうすればよいですか?

次の機能をサポートするドキュメント フレームワークを探しています。

• コード コメントから生成
• 検索可能
• カスタマイズ可能なスタイリング
• NTH: リンクされた参照 (どこかでクラスを参照する場合、クラス名はクラスのドキュメントにリンクする必要があります)

作業中の RESTfull API を文書化するために使用したい

私はYARDocについて知っていますが、いくつかの代替案を集めるといいでしょう

YARD スタイルのドキュメントのパラメータが「真実」のステータスにのみ使用されることを示す規則はありますfalseかnil?

次の場合、通常は何を置き換えTruthyますか?

ドキュメントで見つけることができる最も近いのは Boolean ですが、これは私が本当に望んでいるものではありません。

YARD で文書化する最初の gem を書いています。クラスの 1 つに、引数を取らないブロックを期待するコンストラクターを持たせました¹。

YARD は、メソッドが渡すパラメーターの観点からブロック引数を記述するタグを提供しますが、リストが空@yield [params] descriptionの場合は適切にフォーマットされません。paramsパラメーターのないブロックをどのように文書化すればよいですか?

¹ : 技術的には、私はyieldブロックにさえ ing していません。次のようなコードがあります。

...そのため、ブロックには、新しく作成されたオブジェクトのコンテキストで実行されるコードが含まれています。これが何らかの理由でひどい考えである場合、私もそれを知ってうれしいです:)

Markdown でYARDocを使用して Ruby コードを文書化していますが、メソッドの文書に順序なしリスト (HTML の「箇条書き」) を含めたいと考えています。これが私がこれまでに持っているものです：

そして、私は以下を使用してドキュメントを生成しています:

ただし、HTML の箇条書きは生成せず、アスタリスク ( *) をリテラル文字として扱います。結果のdoc/Foo.htmlファイルには次が含まれます。

YARD で Markdown を使用して HTML 箇条書きを挿入するにはどうすればよいですか? 基本的に、上記の出力の各文字を で<li>...</li>囲み、リストを<ul>要素で囲みます。