コード参照情報

このセクションでは、シンボルの定義を表示し、ドキュメント参照を表示し、ビューパラメータ情報機能を使用する方法について説明します。

定義

PyCharmでは、タグ、クラス、フィールド、メソッド、関数などのシンボルがプロジェクトでどのように定義されているかを確認することができます。この目的のために、IDEにはクイック定義ポップアップがあります。

シンボルの定義を表示するには、エディターでシンボルを選択し、Ctrl+Shift+I を押します（または表示 | クイック定義をクリックします）。

または、Ctrl キーを押したまま、任意の記号にカーソルを合わせます。PyCharmは、シンボルをリンクとして表示し、その定義をツールチップに表示します。このリンクをクリックして、シンボルの定義にジャンプします。

右上隅のアイコンをクリックして、検索ツールウィンドウで定義を開きます。編集用に定義のソースコードを開き、ポップアップを閉じるには、アイコン F4をクリックします。ポップアップを閉じずに定義を開くには、 Ctrl+Enterをクリックします。

型定義

クイック型定義機能を使用すると、編集中のコードから切り替えることなく、変数、フィールド、メソッド、またはその他のシンボルのタイプ定義をポップアップで表示できます。

タイプ定義を表示するシンボルにキャレットを置き、表示 | クイック型定義を選択します。

PyCharmには、このアクションのデフォルトのキーボードショートカットはありませんが、設定で手動で構成できます。カスタムショートカットの構成方法の詳細については、キーボードショートカットの構成を参照してください。

パラメーター情報

パラメーター情報ポップアップはメソッドと関数呼び出しのパラメータ名を表示します。エディターに左括弧を入力するか、候補リストからメソッドを選択すると、PyCharmは1秒以内に使用可能なすべてのメソッドシグネチャーを含むポップアップを自動的に表示します（1000ミリ秒）。

ポップアップが閉じている場合、またはIDEがポップアップを自動的に表示しないように構成されている場合は、ポップアップを明示的に呼び出すことができます。これを行うには、Ctrl+P を押します（または表示 | パラメーター情報をクリックします）。

完全なメソッドまたは関数のシグネチャーを表示する

デフォルトでは、パラメータ情報ポップアップには簡単なシグネチャーが表示されます。メソッド名と返される型を含む完全なシグネチャーを表示するようにIDEを設定できます。

設定/環境設定ダイアログ Ctrl+Alt+Sでエディター | 一般 | コード補完に移動し、完全なメソッド・シグネチャーを表示するチェックボックスを選択します。

必要なサードパーティのJavaScript ライブラリをプロジェクトのソースパスに含めてください。そうしないと、パラメータの名前は表示されません。

設定/環境設定ダイアログ Ctrl+Alt+Sで、エディター | 一般 | コード補完に移動します。
パラメータ情報のポップアップをミリ秒単位で表示するフィールドに、ポップアップが表示されるまでの時間をミリ秒単位で指定します。

ポップアップが自動的に表示されないようにするには、パラメータ情報のポップアップをミリ秒単位で表示するチェックボックスをオフにします。

インレイ・ヒント

インレイヒントは、エディターに表示される特別なマーカーであり、呼び出されたメソッドが期待するパラメーターの名前など、コードに関する追加情報を提供します。他のタイプのヒントは、注釈、メソッドのパラメーター、使用箇所などについて通知します（言語によって異なります）。

一部のヒントはデフォルトで有効になっています。

設定/環境設定 | エディター | インレイ・ヒントでインレイヒントを微調整できます。各タイプの機能の詳細な説明については、インレイ・ヒントを参照してください。

パラメータヒント例外リストを構成する

特定のメソッドのパラメーターヒントを表示したくない場合は、例外を使用してリストを構成できます。デフォルトでは、例外リストには多くの事前定義されたメソッドが含まれています。リストからメソッドを削除して、そのヒントを表示したり、新しいメソッドを追加してヒントをエディターで非表示にしたりできます。

設定/環境設定ダイアログ Ctrl+Alt+Sで、エディター | インレイ・ヒントを選択し、必要な言語をクリックします。
中央のセクションのリストでパラメーターのヒントを選択します。
ヒントを構成するためのオプションが右側で使用可能になります。
ヒントをブラックリストセクションに表示したくないメソッドを追加します。
ヒントを表示したくないケースをブラックリストセクションに追加します。ケースを追加するには、コード内のインラインヒントをクリックし、Alt+Enter を押して現在のメソッドのヒントを表示しないを選択します。
変更を適用し、ダイアログを閉じます。

クイック・ドキュメント

クイック・ドキュメントポップアップを使用して、任意のシンボルまたはメソッドシグネチャーの情報を素早く取得できます。

PyCharmは、PEP-257(英語)に従って作成されたインラインドキュメントを認識します。

必要な記号の上にマウスを移動してそのドキュメントを表示するか、記号にキャレットを置き、Ctrl+Q （表示 | クイック・ドキュメント）を押します。
もう一度 Ctrl+Q を押して、ポップアップとツールバーを切り替えます。
ドキュメントトピックのリンクをクリックして、最上位の要素（この例ではmath）または関連する型（この例ではfloat）のドキュメントをプレビューします。

ポップアップでをクリックしてフォントサイズを変更するか、クイックドキュメントツールバーを表示するか、ソースコードに移動します。

マウスオーバー時にクイックドキュメントを無効にする

設定/環境設定ダイアログ Ctrl+Alt+Sで、エディター | コード編集 | クイック・ドキュメントに移動し、マウス移動でクイック・ドキュメントを表示するチェックボックスをオフにします。
ポップアップでをクリックして、マウスの動きで表示オプションを無効にすることもできます。

この場合、キャレットにあるシンボルのドキュメントを表示するには、Ctrl+Q を押すか、メインメニューから表示 | クイック・ドキュメントを選択します。

外部ドキュメント

外部のドキュメントは、Webブラウザで必要な情報を開き、関連するシンボルにナビゲートし、同時に参照できるように情報を保持することができます。

PyCharmはSciPy、NumPy(英語)、PyGTK(英語)、およびPythonインタープリター用にインストールした他のモジュールのドキュメントを表示します。外部のドキュメントは、設定/環境設定の外部ドキュメントページで正しく設定する必要があります。

外部ドキュメントの参照

現在のキャレット位置にあるシンボルのドキュメントをWebブラウザで表示するには、Shift+F1 を押すか、メインメニューから表示 | 外部ドキュメントを選択します。

外部ドキュメントを見るには、まずドキュメントのURLを構成する必要があります。PyCharmには、pandas、wx、kivy、PySide、PyQt5、PyQt4、matplotlib、pyramid、flask、およびgtkのURLが付属しています。事前定義されたURLのセットを変更するか、プロジェクト設定/環境設定に新しいURLを追加することができます。

外部ドキュメントを設定する

設定/環境設定ダイアログ Ctrl+Alt+S でツール | 外部ドキュメントを開きます。
新しいドキュメントのURLを追加するには、をクリックします。開いたダイアログで、モジュール名と対応する外部文書のURLを指定します。
外部文書がローカルにある場合は、それへのローカルパスを指定してください。
事前設定されている文書のURLを変更するには、ツール | 外部ドキュメントダイアログで文書モジュールを選択してダブルクリックするか、をクリックします。
URLパターンを設定するには、使用可能なマクロフィールドでマクロを選択して挿入ボタンをクリックします。
各文書モジュールはそれぞれ固有の構造を持っているため、マクロを追加するときは注意してください。

生産性のヒント

ツールチップのテキストをクリップボードにコピーする: ツールチップのテキストをクリップボードにコピーするには、Alt （Linuxの場合は Ctrl+Alt）を押しながらツールチップをクリックします。
コンテキスト情報を表示する: 現在のメソッドまたはクラスの宣言が表示されていない場合は、Alt+Qを押すことでツールチップに表示できます。

最終更新日: 2020年8月19日

PyCharm 2020.2ヘルプ

コード参照情報

定義

型定義