PyCharm 2024.3 ヘルプ

コードリファレンス情報

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

パラメーター情報

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

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

View Parameter Info

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

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

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

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

パラメーター情報ポップアップを設定する

  1. 設定ダイアログ(Ctrl+Alt+S)で、エディター | 一般 | コード補完に移動します。

  2. パラメーター情報のポップアップをミリ秒単位で表示するフィールドに、ポップアップが表示されるまでの時間をミリ秒単位で指定します。

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

インレイヒント

インレイヒントは、エディターに表示される特別なマーカーであり、コードに関する追加情報を提供します。

Inlay hints example

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

設定 | エディター | インレイヒントでインレイヒントを微調整できます。各タイプの動作の詳細については、「インレイヒント」を参照してください。

クイックドキュメント

クイックドキュメント機能を使用すると、エディターから任意のシンボルの情報をすばやく取得できます。コード要素にマウスを移動すると、ポップアップにコードドキュメントが表示されます。

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

ポップアップのクイックドキュメント

ポップアップでクイックドキュメントを表示

  • エディターで必要なシンボルの上にマウスを置きます。

  • キャレットをシンボルに置き、Ctrl+Q表示 | クイックドキュメント)を押します。

    Ctrl+Q をもう一度押して、ドキュメントツールウィンドウでこのドキュメントを開きます。

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

ホバー時にクイックドキュメントを無効にする

デフォルトでは、コード要素の上にカーソルを置くと、クイックドキュメントのポップアップが表示されます。クイックドキュメント機能を明示的に呼び出した後にのみポップアップを表示するように IDE を構成できます。

  • ポップアップで the Show Options Menu icon をクリックし、マウス移動時に表示するオプションを無効にします。

  • 設定ダイアログ(Ctrl+Alt+S)で、エディター | コード編集 | クイックドキュメントに移動し、ホバー時にクイックドキュメントを表示するチェックボックスをオフにします。

    この場合、キャレットでシンボルのドキュメントを表示するには、Ctrl+Q を押すか、メインメニューから表示 | クイックドキュメントを選択します。ドキュメントはポップアップで表示されますが、ツールウィンドウにすぐに表示されるように IDE を設定できます。

ツールウィンドウのクイックドキュメント

ツールウィンドウでドキュメントを表示する

デフォルト設定では、Ctrl+Q表示 | クイックドキュメント)を押すと、ポップアップでクイックドキュメントが開きます。設定を変更して、ツールウィンドウにドキュメントを表示できます。

  • クイックドキュメントポップアップで、the Show Options Menu icon をクリックし、ドキュメントのポップアップを前に表示オプションを無効にします。

  • ドキュメントツールウィンドウで、ツールウィンドウツールバーの Show Options Menu アイコンをクリックし、ドキュメントのポップアップを前に表示オプションを無効にします。

ツールウィンドウにドキュメントを保持する

ツールウィンドウで特定のコード要素のドキュメントを開き、現在のファイルの他の要素のドキュメントを表示し続けることができます。

  1. キャレットを必要なコード要素に配置し、Ctrl+Q を押します。ポップアップが表示されたら、Ctrl+Q をもう一度押してツールウィンドウに切り替えます。

    ドキュメントタブのアスタリスク記号(*)は、タブが固定されていないことを意味します。そのため、そのコンテンツは、エディターで選択した別のコード要素のドキュメントに置き換えられます。

  2. ドキュメントツールウィンドウでドキュメントのあるタブを右クリックし、このドキュメントを保持オプションを有効にします。

    その後、現在のドキュメントタブが固定されます。エディターに戻って、ポップアップまたはツールウィンドウの新しいタブで開く他のコード要素のドキュメントを表示できます。

コード要素の上にマウスを置くと、ドキュメントを表示できます。

ツールウィンドウツールバーの Options アイコンをクリックして、マウス移動時に表示するおよびソースから自動更新オプションを有効にします。

キャレットをクリックするか、キャレットを移動することにより、エディターのシンボルにキャレットを配置するときにドキュメントを表示できます。

ツールバーの Options アイコンをクリックし、マウス移動時に表示するを無効にして、ソースから自動更新オプションを有効にします。

キャレットをシンボルに配置して Ctrl+Q を押すか、メインメニューから表示 | クイックドキュメントを選択すると、ドキュメントを表示できます。

ツールウィンドウツールバーの Options アイコンをクリックし、マウス移動時に表示するおよびソースから自動更新オプションを無効にします。

外部ドキュメント

外部ドキュメントでは、必要な情報が Web ブラウザーで開かれるため、関連するシンボルに移動し、同時に参照できるように情報を保存できます。PyCharm は、SciPy、NumPy(英語)PyGTK(英語)、Python インタープリター用にインストールしたその他のモジュールのドキュメントを示します。外部ドキュメントは、設定の外部ドキュメントページで適切に設定する必要があります。

外部ドキュメントの参照

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

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

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

  1. 設定ダイアログ(Ctrl+Alt+S)でツール | 外部ドキュメントを開きます。

    Configuring external documentation
  2. 新しいドキュメントの URL を追加するには、the Add button をクリックします。開いたダイアログで、モジュール名と対応する外部ドキュメントの URL を指定します。

    Adding a URL for numpy documentation

    外部ドキュメントがローカルにある場合は、それへのローカルパスを指定してください。

  3. 事前設定されているドキュメントの URL を変更するには、ツール | 外部ドキュメントダイアログでドキュメントモジュールを選択してダブルクリックするか、the Edit button をクリックします。

  4. URL パターンを設定するには、使用可能なマクロフィールドでマクロを選択して挿入ボタンをクリックします。

    Modifying the URL for the matplotlib documentation

    各ドキュメントモジュールはそれぞれ固有の構造を持っているため、マクロを追加するときは注意してください。

型情報

PyCharm では、式の種類を識別できます。

  • 必要なコード要素にキャレットを置き、Ctrl+Shift+P を押します。または、メインメニューから表示 | 型情報を選択します。

生産性のヒント

ツールチップのテキストをクリップボードにコピーする

ツールチップのテキストをクリップボードにコピーするには、Alt (Linux の場合は Ctrl+Alt)を押しながらツールチップをクリックします。

コンテキスト情報を表示する

現在のメソッドまたはクラスの宣言が表示されていない場合は、Alt+Q を押すことでツールチップに表示できます。

関連ページ:

JavaScript ライブラリを構成する

言語と IDE のコンテキストでは、ライブラリはファイルまたはファイルのセットです。これらのファイルの関数とメソッドは、編集したプロジェクトコードから PyCharm が取得する関数とメソッドに加えて、PyCharm の内部知識に追加されます。プロジェクトのスコープでは、そのライブラリはデフォルトで書き込み保護されています。PyCharm は、2 つの事前定義された自動生成ライブラリフォルダーを予約します。node_modules プロジェクト package.json のオブジェクトにリストされてい...

インレイヒント

インレイヒントはエディターに表示され、コードに関する追加情報を提供して、読みやすく移動しやすくします。インレイヒントを有効または無効にする設定ダイアログ () を開き、に移動して、コードビジョンセクションを展開し、使用箇所チェックボックスを選択します。エディターでヒントを右クリックし、特定の種類のヒントを無効にするか、このカテゴリのすべてのヒントを無効にするかを選択します。コードビジョンコードビジョンヒントは、シンボルの使用回数をエディターに表示し、誰がそれを作成したかを示し、新しいシンボルまた...

Python インタープリターを構成する

PyCharm の Python インタープリター:PyCharm で Python コードを使用するには、少なくとも 1 つの Python インタープリターを構成する必要があります。Python インストールで使用可能なシステムインタープリターを使用できます。また、Virtualenv、pipenv、Poetry、または conda 仮想環境を作成することもできます。仮想環境は、基本インタープリターとインストールされたパッケージで構成されます。PyCharm Professional では、SS...

外部ドキュメント

外部ドキュメント:Python 外部ドキュメントを表示するには、最初にドキュメントの URL を構成する必要があります。PyCharm には、pandas、wx、kivy、PySide、PyQt5、PyQt4、matplotlib、pyramid、flask、gtk の URL が付属しています。事前定義された URL のセットを変更するか、プロジェクト設定に新しい URL を追加できます。詳細は、外部ドキュメントを設定するを参照してください。モジュール名この列には、モジュールの名前が表示され...

PyCharm リファクタリングチュートリアル

このチュートリアルの内容:このチュートリアルでは、有理数を利用する単純なクラスの例を使用して、PyCharm で利用可能ないくつかのリファクタリングを示します。前提条件:次の前提条件が満たされていることを確認してください。PyCharm バージョン 2016.2 以降で作業しています。プロジェクトはすでに作成されています。例の準備:プロジェクトに Python ファイル rational.py を作成し、次のコードを追加します。from collections import namedtupl...

定義と型定義

PyCharm では、クラス、フィールド、メソッド、関数、タグなどのシンボルがプロジェクト内のどこでどのように定義されているかを確認できます。この目的のために、IDE にはクイック定義ポップアップが用意されています。キャレットでシンボルの定義を表示エディター内のシンボルにキャレットを置き、を押します (またはメインメニューでクリックします)。あるいは、キーを押したまま、任意の記号の上にマウスを置きます。PyCharm はシンボルをリンクとして表示し、その定義をツールチップに表示します。この...