JetBrains Rider 2024.1 ヘルプ

クイックドキュメント

JetBrains Rider を使用すると、エディター内でシンボルのドキュメントをすばやく確認できます。シンボルがサポートされている形式 (C# の XML-docs など) でドキュメント化されている場合、すべてのドキュメントが適切な形式で表示されます。それ以外の場合は、基本的なシンボル情報が表示されます (完全なメソッドシグネチャーまたは型の可視性と名前空間など)。

Quick documentation popup

デフォルトでは、シンボルの上にマウスを置くと、クイックドキュメントポップアップが表示されます。これを無効にして常にポップアップを明示的に呼び出す場合は、ポップアップで をクリックしてからマウス移動時に表示するをクリックするか、JetBrains Rider 設定 Ctrl+Alt+Sエディター | コード編集ページでホバー時にクイックドキュメントを表示するチェックボックスをオフにします。このオプションに関係なく、明示的な呼び出しが可能になります。マウスホバー時にクイックドキュメントを表示したい場合は、その設定ページのツールチップ遅延フィールドで表示遅延 (ミリ秒単位) を設定できます。

シンボルのクイックドキュメントを表示

  1. キャレットを配置する

    • エディターのシンボル参照

    • ドキュメントコメント内の任意の場所。

  2. Ctrl+Q を押すか、メインメニューから表示 | クイックドキュメントを選択します。または、Ctrl+Shift+A を押して、ポップアップにコマンド名を入力し、そこで選択することもできます。

  3. 表示されるクイックドキュメントポップアップでは、シンボルのドキュメントを勉強し、ハイパーリンクをたどって関連するドキュメントを表示できます。

記号参照を入力するとすぐにクイックドキュメントを呼び出すことができます。これは、正しい記号を使用したことを確認できます。有効なステートメントである必要はありません。正しいシンボル名で十分です。

JetBrains Rider: Quick Documentation for incomplete code

括弧なしでメソッド呼び出しを入力してからクイックドキュメントを呼び出すと、JetBrains Rider では、メソッドに複数のシグネチャーがあるかどうかを調べるために、メソッドシグネチャーを選択できます。

Choosing the target for quick documentation

クイックドキュメントポップアップの追加機能は次のとおりです。

  • 設定ボタン 。ポップアップを調整するためのさまざまなオプションと、文書化されたシンボル F4 へのナビゲーションを提供します。

    JetBrains Rider: Quick Documentation options
  • ポップアップの左上隅にあるブラウザーのような戻る / 進むナビゲーションボタン。これらのボタンは、ポップアップにツールバーを表示するように選択すると表示されます。

  • システムシンボルに関する MicrosoftDocs の記事など、関連するエンティティのドキュメントに移動できるハイパーリンク。

デフォルトでは、JetBrains Rider はポップアップにクイックドキュメントを表示します。ツールウィンドウで表示するには、ポップアップで をクリックしてドキュメントツールウィンドウで開くを選択するか、Ctrl+Q を 2 回押します。

JetBrains Rider: Documentation tool window

JetBrains Rider がオーバーライドおよび実装されたメンバーのクイックドキュメントを表示する場合、次の規則が適用されます。

  • オーバーライド / 実装されたメンバーにドキュメントがなく、そのベースメンバーにドキュメントがある場合は、ベースメンバーのドキュメントが表示されます。

  • 両方がドキュメント化されている場合は、オーバーライド / 実装されたメンバーのドキュメントが表示されます。

関連ページ:

パラメーター情報

関数呼び出しを書いたり調べたりするときはいつでも、JetBrains Rider は、関数のすべてのオーバーロードで許可されている引数の詳細を表示できます。ポップアップには、関数の XML ドキュメントから取得したパラメーターと簡単な説明 (利用可能な場合) を含むすべての公開署名が表示されます。パラメーター情報を使用:パラメーターを入力すると、JetBrains Rider は入力されたパラメーターと互換性のある次のシグネチャーを自動的にハイライトし、適用できないシグネチャーをグレー表示しま...

コンテキストアクション

コンテキストアクションは、エディターで直接利用できるコード変換ヘルパーです。クイックフィックスとは対照的に、コンテキストアクションは問題の解決やコードの改善を目的としているためはなく、アクセス修飾子の変更、null をチェックするコードの生成、'foreach' の 'for' への変換などの小さな変更を素早く導入できます。JetBrains Rider は、サポートされているすべての言語で数百のコンテキストアクションを提供します。完全なリストは、JetBrains Rider 設定のページお...

クイック定義

クイック定義を使用して、現在の編集位置を移動せずに、現在のコンテキストで使用されている型とメンバーの宣言と実装を調べます。ソリューションコードとライブラリシンボルの両方で機能します。コンテキストを目的の定義に切り替える宣言に移動とは対照的に、クイック定義は定義を確認できるポップアップを開きます。クイック定義ポップアップから、シンボルをさらに調べることができます。をクリックしてソースの編集を選択するか、を押して新しいエディタータブで定義を開き、ポップアップを閉じます。をクリックし、検索ツールウィ