WebStorm 2025.1 ヘルプ

インラインドキュメントの表示

クイックドキュメントの参照を使用すると、プロジェクトおよびその依存関係からのシンボルの参照、および標準の JavaScript オブジェクトおよびメソッドの参照を表示できます。詳細については、「JavaScript ドキュメントの検索および TypeScript ドキュメントのルックアップ」を参照してください。

プロジェクトシンボルまたはプロジェクトの依存関係からのシンボルの場合、WebStorm は対応する JSDoc コメント(英語)からドキュメントを生成します。コメントを作成するには、ドキュメント化するメソッド / 関数またはフィールドの宣言の前にキャレットを置き、開始ブロックコメント /** を入力して、Enter を押します。詳細については、「Jsdoc コメント」を参照してください。

デフォルトでは、ドキュメントはドキュメントポップアップに表示されますが、いつでもドキュメントツールウィンドウで開くことも、デフォルトでドキュメントツールウィンドウに表示されるように設定することもできます。

明示的にコード補完を呼び出すと、候補リストで選択されたエントリのクイックドキュメントが自動的に表示されます。クイックドキュメントルックアップの動作は、設定ダイアログのコード補完ページのドキュメントのポップアップを表示するフィールドで構成されます。

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

Quick documentation in a popup

キャレットにあるシンボルのドキュメントを表示する

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

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

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

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

    Configure Quick Doc popup

クイックドキュメントポップアップを構成する

クイックドキュメントのフォントサイズを変更する

  • クイックドキュメントポップアップで the Show Options Menu icon をクリックし、フォントサイズを調整を選択して、スライダーを動かします。

  • Ctrl キーを押したままマウスホイールを回します。

    この機能を動作させるには、エディター設定の一般ページで有効にする必要があります。

    詳細は、便利なエディター構成を参照してください。

ドキュメントポップアップの遅延を指定する

  • ポップアップが表示されるまでの遅延を指定するには、設定ダイアログ (Ctrl+Alt+S) でエディター | コード編集 | エディターのツールチップに移動し、ツールチップ遅延フィールドに必要な値を入力します。

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

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

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

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

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

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

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

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

    Quick Doc popup: clear Show popup first
  • ドキュメントツールウィンドウで、ツールウィンドウツールバーの the Show Options Menu icon をクリックし、ドキュメントのポップアップを前に表示オプションを無効にします。

    Quick Doc tool window: clear Show popup first

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

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

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

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

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

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

    Keep Quick Documentation in tool window

ツールウィンドウでは、コードドキュメントが固定されていないタブ(アスタリスク記号(*)でマークされたタブ)に表示されます。このタブを操作するには、いくつかの方法があります。

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

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

View on hover

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

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

View symbols at caret

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

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

View doc with shortcut

関連ページ:

JavaScript ドキュメントの検索

WebStorm は、標準の JavaScript API、プロジェクトとその依存関係からのシンボル、外部ライブラリで定義されたシンボルのリファレンスを示しています。ドキュメントポップアップでシンボルのドキュメントを表示し、リンクが利用可能な場合は外部サイトのドキュメントを開くことができます。プロジェクトシンボルまたはプロジェクト依存のシンボルの場合、WebStorm は対応する JSDoc コメントからドキュメントを生成します。標準の JavaScript オブジェクトまたはメソッドの場合、We...

TypeScript

WebStorm は TypeScript ソースコードの開発、実行、デバッグをサポートします。WebStorm は .ts および .tsx ファイルを認識し、ユーザー側で追加の手順を踏むことなく編集するためのコーディング支援を提供します。TypeScript ファイルはアイコン。TypeScript 対応のコーディング支援には、キーワード、ラベル、変数、パラメーター、関数の補完、エラーと構文のハイライト、フォーマット、多数のコードインスペクションとクイックフィックス、および一般的で TypeScript...

Jsdoc コメント

WebStorm は Jsdoc コメントを認識し、開始ブロックコメントを入力してを押すと、、やその他のタグを自動的に挿入することで作成できます。JSDoc コメントは、JavaScript および TypeScript でのを使用したドキュメント検索に使用されます。JavaScript ドキュメントの検索および TypeScript ドキュメントのルックアップを参照してください。また、連鎖メソッドでの型アノテーションおよびメソッド戻り型ヒントにも使用されます。WebStorm は、ドキュメント...

ドキュメントツールウィンドウ

デフォルトでは、WebStorm はポップアップにクイックドキュメントを表示します。ツールウィンドウで表示するには、ポップアップでクリックしてドキュメントツールウィンドウで開くを選択するか、を 2 回押します。または前のページに切り替えるか、次のドキュメントページに移動します(たとえば、ハイパーリンクをクリックした後)。macOS では、3 本の指で右から左、左から右にスワイプするジェスチャーも使用できます。ドキュメントが現在開いているシンボルのソースコードに移動します。ドキュメントのポップ...

エディターの基本

WebStorm エディターは、コードの作成、読み取り、変更に使用する IDE の主要部分です。エディターは次の領域で構成されています。スクロールバーは現在のファイルのエラーと警告を表示します。パンくずリストは、現在のファイルのコード内を移動できます。ガターには、行番号、アノテーション、コンテキストに依存するアクションアイコンが表示されます。タブには、現在開いているファイルの名前が表示されます。ナビゲーション:さまざまなショートカットを使用して、エディターウィンドウとさまざまなツールウィンドウ...

定義と型定義

クイック定義参照は、プロジェクトシンボル (クラス、メソッド / 関数、フィールド、タグなど) がどこでどのように定義されているかを示します。TypeScript オブジェクトの場合、WebStorm はその推論されたタイプも表示します。マークアップ言語の場合、WebStorm は指定された DTD またはスキーマからシンボルの定義を取得します。詳細については、「HTML および XML」を参照してください。WebStorm はポップアップまたはツールチップにシンボル定義を表示できます。ポップアップ...