コードリファレンス情報
パラメーター情報
パラメーター情報ポップアップには、メソッド呼び出しと関数呼び出しのパラメーターの名前が表示されます。RubyMine は、エディターで左括弧を入力するか、候補リストからメソッドを選択すると、1 秒 (1000 ミリ秒) 以内に、使用可能なすべてのメソッドシグネチャーを含むポップアップを自動的に表示します。
ポップアップが閉じている場合、または IDE がポップアップを自動的に表示しないように構成されている場合は、ポップアップを明示的に呼び出すことができます。これを行うには、Ctrl+P を押します(または をクリックします)。
![Parameter info popup](https://resources.jetbrains.com/help/img/idea/2024.1/rm_view_reference_parameter_info.png)
完全なメソッドまたは関数のシグネチャーを表示する
デフォルトでは、パラメーター情報ポップアップには簡単なシグネチャーが表示されます。メソッド名と返される型を含む完全なシグネチャーを表示するように IDE を設定できます。
設定ダイアログ(Ctrl+Alt+S)で、 に移動し、完全なメソッドシグネチャーを表示するチェックボックスを選択します。
パラメーター情報ポップアップを設定する
設定ダイアログ(Ctrl+Alt+S)で、 に移動します。
パラメーター情報のポップアップをミリ秒単位で表示するフィールドに、ポップアップが表示されるまでの時間をミリ秒単位で指定します。
ポップアップが自動的に表示されないようにするには、パラメーター情報のポップアップをミリ秒単位で表示するチェックボックスをオフにします。
インレイヒント
インレイヒントは、エディターに表示される特別なマーカーであり、呼び出されたメソッドが予期するパラメーターの名前など、コードに関する追加情報を提供します。アノテーション、メソッドパラメーター、使用箇所、問題などには、さまざまな種類のインレイヒントがあります。
![パラメーターヒント Parameter hints](https://resources.jetbrains.com/help/img/idea/2024.1/rm_view_reference_parameter_hints.png)
インレイヒントの構成
ヒント設定を選択します。
に移動します。または、ヒントを右クリックしてチェックボックスを使用して、特定のインレイヒントを有効または無効にします。
特定のケースのパラメーターヒントを表示したくない場合は、例外のリストを構成できます。デフォルトでは、例外リストには多数の定義済みメソッドが含まれています。リストからメソッドを削除してヒントを表示したり、新しいメソッドを追加してエディターでヒントを非表示にしたりできます。
クイックドキュメント
クイックドキュメント機能を使用すると、エディターから任意のシンボルの情報をすばやく取得できます。コード要素にマウスを移動すると、ポップアップにコードドキュメントが表示されます。シンボルには、YARD または RDoc マークアップまたは SDK ドキュメントに従って作成されたドキュメントコメントが付属している必要があることに注意してください。
ポップアップのクイックドキュメント
ポップアップでクイックドキュメントを表示
エディターで必要なシンボルの上にマウスを置きます。
キャレットをシンボルに置き、Ctrl+Q (
)を押します。Ctrl+Q をもう一度押して、ドキュメントツールウィンドウでこのドキュメントを開きます。
ポップアップで をクリックしてフォントサイズを変更するか、クイックドキュメントツールバーを表示するか、ソースコードに移動します。
ホバー時にクイックドキュメントを無効にする
デフォルトでは、コード要素の上にカーソルを置くと、クイックドキュメントのポップアップが表示されます。クイックドキュメント機能を明示的に呼び出した後にのみポップアップを表示するように IDE を構成できます。
ポップアップで
をクリックし、マウス移動時に表示するオプションを無効にします。
設定ダイアログ(Ctrl+Alt+S)で、 に移動し、ホバー時にクイックドキュメントを表示するチェックボックスをオフにします。
この場合、キャレットでシンボルのドキュメントを表示するには、Ctrl+Q を押すか、メインメニューからドキュメントはポップアップで表示されますが、ツールウィンドウにすぐに表示されるように IDE を設定できます。
を選択します。ツールウィンドウのクイックドキュメント
ツールウィンドウでドキュメントを表示する
デフォルト設定では、Ctrl+Q (
)を押すと、ポップアップでクイックドキュメントが開きます。設定を変更して、ツールウィンドウにドキュメントを表示できます。クイックドキュメントのポップアップで、
をクリックし、ドキュメントのポップアップを前に表示オプションを無効にします。
ドキュメントツールウィンドウで、ツールウィンドウのツールバーの
アイコンをクリックし、ドキュメントのポップアップを前に表示オプションを無効にします。
ツールウィンドウにドキュメントを保持する
ツールウィンドウで特定のコード要素のドキュメントを開き、現在のファイルの他の要素のドキュメントを表示し続けることができます。
キャレットを必要なコード要素に配置し、Ctrl+Q を押します。ポップアップが表示されたら、Ctrl+Q をもう一度押してツールウィンドウに切り替えます。
ドキュメントタブのアスタリスク記号(
*
)は、タブが固定されていないことを意味します。そのため、そのコンテンツは、エディターで選択した別のコード要素のドキュメントに置き換えられます。ドキュメントツールウィンドウでドキュメントのあるタブを右クリックし、このドキュメントを保持オプションを有効にします。
その後、現在のドキュメントタブが固定されます。エディターに戻って、ポップアップまたはツールウィンドウの新しいタブで開く他のコード要素のドキュメントを表示できます。
ツールウィンドウでコードドキュメントを表示しているときは、固定されていないタブ(アスタリスク記号(*
)でマークされたタブ)に表示されます。コードドキュメントを操作するには、いくつかの方法があります。
コード要素の上にマウスを置くと、ドキュメントを表示できます。
ツールウィンドウのツールバーにある アイコンをクリックし、マウス移動時に表示するおよびソースから自動更新オプションを有効にします。
キャレットをクリックするか、キャレットを移動することにより、エディターのシンボルにキャレットを配置するときにドキュメントを表示できます。
ツールバーの アイコンをクリックし、マウス移動時に表示するオプションを無効にし、ソースから自動更新オプションを有効にします。
キャレットをシンボルに配置して Ctrl+Q を押すか、メインメニューから
を選択すると、ドキュメントを表示できます。 ツールウィンドウのツールバーにある アイコンをクリックし、マウス移動時に表示するおよびソースから自動更新オプションを無効にします。
型情報
RubyMine では、次の方法で式の型を識別できます。
必要なコード要素にキャレットを置き、Ctrl+Shift+P を押す(またはメインメニューから
を選択する)。
外部ドキュメント
外部のドキュメントは Web ブラウザーで必要な情報を開き、関連するシンボルに移動し、同時に参照できるように情報を保持することができます。
![ブラウザーの外部ドキュメント External documentation in browser](https://resources.jetbrains.com/help/img/idea/2024.1/rm_view_reference_parameter_external_doc.png)
外部ドキュメントの参照
現在のキャレット位置にあるシンボルのドキュメントを Web ブラウザーで表示するには、Shift+F1 を押します(または
をクリックします)。
生産性のヒント
- ツールチップのテキストをクリップボードにコピーする
ツールチップのテキストをクリップボードにコピーするには、Alt (Linux の場合は Ctrl+Alt)を押しながらツールチップをクリックします。
- コンテキスト情報を表示する
現在のメソッドまたはクラスの宣言が表示されていない場合は、Alt+Q を押すことでツールチップに表示できます。
関連ページ:
![](https://resources.jetbrains.com/help/img/idea/2024.1/rm_yard_return_type_info.png)
コードのドキュメント化
YARD および RDoc は、コードをドキュメント化するために複数のライブラリで使用される最も一般的なドキュメント生成ツールです。RubyMine では、クイックドキュメントルックアップを使用して、YARD または RDoc 構文で記述されたドキュメントを表示できます。さらに、RubyMine は、YARD タグで動作する拡張機能を提供します。欠落している YARD タグを作成する、YARD タグの有効性を確認して修正する、YARD タグを活用して、コードインサイトを向上させる (たとえば、オブジェ...
![](https://resources.jetbrains.com/help/img/idea/2024.1/rm_view_reference_definition.png)
定義と型定義
RubyMine では、クラス、フィールド、メソッド、関数、タグなどのシンボルがプロジェクト内のどこでどのように定義されているかを確認できます。この目的のために、IDE はクイック定義ポップアップを備えています。キャレットでシンボルの定義を表示エディター内のシンボルにキャレットを置き、を押します (またはメインメニューでクリックします)。あるいは、キーを押したまま、任意の記号の上にマウスを置きます。RubyMine はシンボルをリンクとして表示し、その定義をツールチップに表示します。このリ...