問題タブ [yardoc]

Ruby では、コードのセクションをすばやくスキャンできるように、コードのセクションを次のように分割することが何度かあります。

これは、yarddoc が文書化するためのものではありません。

これをコードドキュメントに表示されないようにする方法を知っている人はいますか?

github プロジェクトから Yard ドキュメントを生成する方法はありますか? Yard で解析してドキュメントを生成する準備が整った Yard タグ付きのクックブックがいくつかあります。

何か案は？

ありがとうビスワジット

私たちの github リポジトリから引き出して、庭のドキュメントを生成およびホストできるサービスはありますか?

私のチームは、ドキュメントをローカルで生成してからドキュメントに移動する必要があるため、ドキュメントを見たことがないようです。これにより、彼らは Yard 形式で役立つドキュメントを書くこともやめています。

http://www.rubydoc.info/のようなものですが、私のチームだけがアクセスできる非公開のドキュメントを持つことができます。

次のようなメソッドがあります。

このメソッドの呼び出し元が、いくつかのオプションのパラメーターを渡せるようにしたいと考えています。

これをサポートする YARD ドキュメントを書きたいと思います。キーワード引数を使用していない場合は、@option 宣言を使用します。

ただし、YARD 自身のドキュメントには次のように書かれています。

注: キーワード パラメータには、@option ではなく @param を使用します。

だから私は試しました：

YARD はparams私が使用しているキーワード引数しか認識しないため、これは失敗します。正確な失敗は次のとおりです。

そこで、キーワード@optionに置き換えた構文を使用しようとしました。param

その結果、別のエラーが発生します。

params理想的には、このメソッドのユーザーが使用できる 3 つまたは 4 つのオプションでハッシュを記述したいと考えています。これを行う方法はありますか？

現在、yardoc を使用して serverspec テストを文書化しようとしています。このために、それほど悪くない仕事をする yard-serverspec-plugin ruby​​gem をインストールしました。

しかし、私には1つの問題があります。rubygem は「describe」と「context」を同じように扱い、階層構造にはしていません。このため、失敗した serverspec テストに関する正しいドキュメントを見つけるのは困難です。

これらは私のserverspecテストです：

そして、これが文書化される方法です：

ここにハンドラーのコードがあります: https://github.com/rrreeeyyy/yard-serverspec-plugin/blob/master/lib/yard/serverspec/plugin/handler.rb

私の質問は、階層構造を持つ html ドキュメントで 2 つのオブジェクトのみを取得するようにハンドラー コードを調整する方法を誰かが知っているかどうかです。「OS名とバージョン」オブジェクトは本当に役に立たないからです。このようなものがいいでしょう：

よろしくお願いします

Yardoc を使用して、多数の gem と私の会社のアプリの HTML ドキュメントを作成しています。また、スタイル ガイドに準拠するために Ruboco を使用しています。

私が直面している問題は# rubocop:disable Metrics/AbcSize、ドキュメントに表示されるいくつかのメソッド メトリックとそれらのコメント ( など) を有効/無効にする必要があることです。これらを削除するプラグイン、または独自の作成に関するガイドに従うことができるプラグインはありますか?

ラムダを返すメソッドを持つオブジェクトがあります。

そして、 yardoc構文Book#mark_pageを使用してこのメ​​ソッドを文書化したいと思います。ただし、このドキュメントではラムダについて何も見つかりません。

直感的に、私は次のようなものに行きます：

yardoc.org/typesは次のように解析しているため:

(ページ) を含む Proc

_{documentationPS：タグについてはよくわかりません。不適切な場合は削除してください...}