PHPDoc コメント

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

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

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

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

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

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

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

   • Alt+Insert を押してから、 PHPDoc ブロックを生成する を選択し、コード構成を選択して 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. 完全修飾クラス名を使用する チェックボックスを選択またはクリアすることで、プロパティ、関数パラメーター、 return値および throws値などのクラス名の提示方法を PhpStorm に指定できます。

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

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

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