JSDoc コメント
PhpStorm は JSDoc コメントを認識し、開きブロックコメント /** を入力して Enter を押すと、 @param、 @returns、 @プライベート やその他のタグを自動で挿入して、作成をサポートします。 JSDoc コメントは、JavaScript および TypeScript で Ctrl+Q を使ったドキュメント検索に利用され、 JavaScript ドキュメント検索および TypeScript ドキュメント検索 、またチェーンメソッド内の 型アノテーションや メソッド戻り値の型ヒントとしても使われます。
PhpStorm は、ドキュメントコメント内の TODO パターン、 クロージャ コンパイラーアノテーション、 TypeScript 構文も認識し、コード補完、インテンションアクション、その他のコーディング支援で活用します。
JSDoc 入門(英語)および JSDoc でサポートされているタイプ(英語)の例を使用して、JSDoc 構文の詳細な説明を見つけてください。
JSDoc コメントを作成する
文書化するメソッド / 関数またはフィールドの宣言の前にキャレットを置き、開始ブロックコメント
/**を入力して、 Enter を押します。PhpStorm は、該当する場合、パラメーター(
@param)および戻り値(@returns)のリストを含む JSDoc コメントを生成します。 リストされたパラメーター、戻り値などを記述します。
あるいは、専用の Doc コメントを修正 アクションを使用します。 文書化するメソッド / 関数またはフィールドにキャレットを置き、 Ctrl+Shift+A を押して
Doc コメントを修正の入力を開始します。 次に、リストから Doc コメントを修正 を選択し、 Enter を押します。
JSDoc コメントの TypeScript 構文
JavaScript ファイルの JSDoc コメント内で、TypeScript アノテーション(@type や @typedef など)を使用できます。 PhpStorm は TypeScript 構文構造、たとえば 共用体型や @typedef 宣言でのオプションプロパティを認識します。
PhpStorm は TypeScript アノテーションのコード補完を提供します。

@type アノテーションにもとづき、PhpStorm はパラメーターヒントを表示します。

エディターでレンダリングされた JSDoc コメントを表示する
PhpStorm を使うと、JSDoc コメントをより読みやすいフォーマットで表示できます。 この レンダリングされたビューモードでは、アイテムは @ タグでグループ化されて表示されますが、タグ自体はスキップされます。 参照先の Web ページを開いて、参照先のトピックのクイックドキュメントを表示し、読みやすくするためにフォントサイズを調整できます。

レンダリングされたビューモードに入るには、コメントの上にマウスを置き、余白の
をクリックするか、 Ctrl+Alt+Q を押します。 アイコンが
に変わります。

レンダリングされたビューモードを終了するには、ガターで
をクリックするか、JSDoc コメントのコンテキストメニューから レンダリングビューの切り替え を選択するか、 Ctrl+Alt+Q を押します。

現在のファイルのすべての JSDoc コメントに対して レンダリングされたビューモードをオンにするには、ガターのコンテキストメニューから すべての Doc コメントをレンダリング を選択します。

必要に応じて、コンテキストメニューから フォントサイズを調整 を選択し、スライダーを使用してフォントサイズを変更します。

デフォルトでレンダリングされるすべての JSDoc コメントを表示するには、 設定 ダイアログ(Ctrl+Alt+S )を開き、 に移動して、 ドキュメントコメントをレンダリングする チェックボックスを選択します。

レンダリングビューのガターアイコンを非表示にするには、ガターのコンテキストメニューから ガターアイコンを構成する… を選択し、開いた ページの ドキュメントコメントの直接描画 チェックボックスをオフにします。