PhpStorm 2024.1 ヘルプ

PHPDoc コメント

ドキュメントコメントの場合、PhpStorm はデフォルトで有効になっている補完を提供します。PhpStorm は、/** の開始タグを入力して Enter を押すか、Alt+Insert を押して、コード構造(クラス、メソッド、関数など)をドキュメント化するときに、PHPDoc ブロック(英語)のスタブを作成します。選択に応じて、PhpStorm は必要なタグを作成するか、空のドキュメントスタブを追加します。

追加の PHP 固有のタグが必要な場合、PhpStorm は現在のコンテキストに関連するタグ名を提案するコード補完を提供します。特定のタグに複数の値がある場合、コード補完は利用可能な値のリストを提供します。

PHPDoc コメントでは、PhpStorm は ZEND、PEAR、その他のコーディング標準に準拠したフォーマットオプションをサポートしています。

ソースコード内の PHPDoc コメントは、クイックドキュメントルックアップで利用できます。これにより、文書化されたシンボルの迅速な情報を得ることができます。Ctrl+Q を押すと、ドキュメントツールウィンドウでレビュー用に開くことができます。

ドキュメントのコメントを有効にする

  1. Ctrl+Alt+S を押して設定を開き、エディター | 一般 | スマートキーを選択します。

  2. Enter セクションで、ドキュメントコメントスタブを挿入するチェックボックスをオンまたはオフにします。

コード構造の PHPDoc ブロックを生成する

  1. PHPDoc ブロックの生成を呼び出すには、次のいずれかの操作を行います。

    • 必要なコード構成(クラス、メソッド、関数など)の前にキャレットを置き、開始ブロックコメント /** を入力し、Enter を押します。

    • エディターのコンテキストメニューで生成 | PHPDoc ブロックを生成するを選択し、コード構成を選択して PHPDoc コメントを生成します。

    • Alt+Insert を押してから、PHPDoc ブロックを生成するを選択し、コード構成を選択して PHPDoc コメントを生成します。

    Generate PHPDoc

    PhpStorm は、指定されたコード構成を解析し、可能な場合はパラメーター、戻り値、変数、フィールドのデータを抽出し、これに基づいてドキュメントブロックのスタブを生成します。

  2. リストされたパラメーターと、必要に応じて戻り値を記述してください。PhpStorm は、コードインスペクション設定に従って、コメント内の構文をチェックして処理します。

PHPDoc コメントブロックにタグを作成する

PhpStorm は、指定されたコード構成を解析し、可能な場合はパラメーター、戻り値、変数、フィールドのデータを抽出し、これに基づいてドキュメントブロックのスタブを生成します。必要に応じて、不足している情報を記入することができます。

  1. PHPDoc ブロックで、空の行を選択し、Ctrl+Space を押します。

  2. 候補リストから関連するタグを選択します。

  3. 入力したタグに複数の値がある場合は、Ctrl+Space を押して、候補リストから目的の値を選択します。

PHPDoc コメント内のフォーマット

PHPDoc コメントの外観、クラス名の表示、デフォルトのタグの並べ替え順序を構成できます。プロパティのタグは構成できなくなり、デフォルトの @var(英語) タグが自動的に挿入されることに注意してください。詳細については、「https://github.com/phpDocumentor/fig-standards/pull/55(英語)」を参照してください。

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

  2. PHPDoc タブに切り替えて、チェックボックスを選択または選択解除して目的の外観オプションを設定します。

  3. 完全修飾クラス名を使用するチェックボックスを選択またはクリアすることにより、プロパティ、関数パラメーター、戻り値およびスロー値などのクラス名を PhpStorm に提示する方法を指定します。

  4. 必要に応じて、PHPDoc タグを並べ替えるチェックボックスを選択して、生成された PHPDoc タグをどのようにソートするかを定義します。

    • リストに PHPDoc タグのエントリを追加または削除するには、the Add buttonthe Remove button を使用します。

    • the Up buttonthe Down button を使用して、PHPDoc タグのエントリの順番を並べ替えます。

PHPDoc コメントのレンダリング

PhpStorm を使用すると、エディターで PHPDoc コメントをレンダリングできます。レンダリングされたコメントは読みやすく、余分なタグでコードをオーバーロードしません。

必要なドキュメントコメントの横のガターで the Toggle Rendered View icon をクリックして(または Ctrl+Alt+Q を押して)、レンダリングビューを切り替えます。the Toggle Rendered View icon をクリックしてコメントを編集します。

Javadocs in the editing mode
Javadocs in the rendered mode

レンダリングされた PHPDoc コメントを使用すると、リンクをクリックして参照先の Web ページに移動したり、参照先のトピックに関する簡単なドキュメントを表示したりできます。

フォントサイズを変更するには、エディターで PHPDoc コメントを右クリックし、コンテキストメニューからフォントサイズの調整を選択します。レンダリングされたコメントは、クイックドキュメントポップアップと同じフォントサイズを使用することに注意してください。

デフォルトで PHPDoc コメントをレンダリングする

エディターで常に PHPDoc コメントをレンダリングするように IDE を構成できます。

  • (ガターの the Toggle Rendered View icon アイコンまたは the Toggle Rendered View icon) を右クリックし、すべてレンダリングオプションを有効にします。

    または、設定ダイアログ Ctrl+Alt+Sエディター | 一般 | 外観を選択し、ドキュメントコメントをレンダリングするオプションを有効にします。

レンダリングされた PHPDoc コメントを編集するには、コメントの横のガターにある the Toggle Rendered View icon アイコンをクリックします。

PHPDoc コードインスペクションの使用

PhpStorm は、PHPDoc ブロックを対象とした事前定義コードインスペクションのセットを提供します。これらのインスペクションは、クラス、メソッド、関数、変数、定数に PHPDoc コメントが提供されているかどうか、コメント内のタグが文書化された項目と一致するかどうかをチェックします。

PHPDoc インスペクションを有効または無効にする

  1. 設定ダイアログ(Ctrl+Alt+S)で、エディター | インスペクションを選択します。

  2. 開いているインスペクションページで、PHP にある PHPDoc ノードを展開します。

  3. あらかじめ定義されたインスペクションのリストで、インスペクションの横にあるチェックボックスをオンまたはオフにしてインスペクションを有効または無効にします。

PHPDoc のコメントが特定のタイプのコード構造に対して提供されていることを確認する

  1. 欠落した PHPDoc コメントインスペクションを有効にします。

  2. オプション領域で、必要なエレメント型の横にあるチェックボックス(クラス、メソッド、関数、変数、定数)を選択します。

    メソッドまたは関数にパラメーターまたは戻り値が含まれていない場合、欠落した PHPDoc コメントエラーの報告を抑制するには、@param/@return なしで PHPDoc を無視チェックボックスをオンにします。

関連ページ:

コードリファレンス情報

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

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

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

コードインスペクション

PhpStorm には、プロジェクト内の異常なコードを検出して修正する一連のコードインスペクションがあります。IDE は、さまざまな問題を見つけてハイライトし、デッドコードを見つけ、考えられるバグやスペルの問題を見つけ、全体的なコード構造を改善することができます。インスペクションは、すべてのプロジェクトファイルまたは特定のスコープでのみ(たとえば、本番コードまたは変更されたファイルでのみ)コードをスキャンできます。すべてのインスペクションには、問題がコードに影響を与える可能性がある程度の重大度レ...

インスペクション

このページを使用して、インスペクションプロファイルのカスタマイズ、インスペクション重大度レベルの構成、インスペクションの無効化と有効化、さまざまなスコープのインスペクションの構成を行います。変更されたインスペクションは青でハイライトされます。プロファイルの管理:プロファイル設定したいプロファイルの名前を選択します。適用をクリックすると、選択したプロファイルがプロジェクトのハイライトに自動的に使用されます。IDE にコピー / プロジェクトにコピー: プロジェクトまたはグローバル(IDE)レベルで選...

定義と型定義

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

インレイヒント

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