PyCharm 2026.1 Help

JSDocコメント

PyCharm は JSDocコメントを認識し、開始ブロックコメント /** を入力して Enter を押すと、 @param@returns@private やその他のタグを自動で挿入して作成をサポートします。 JSDocコメントは、JavaScript や TypeScript で Ctrl+Q を使ったドキュメント参照や、 JavaScript ドキュメント検索および TypeScript ドキュメント検索 、さらにチェーンメソッドでの 型アノテーションメソッド戻り値型ヒントに使用されます。

PyCharm は、ドキュメントコメント内の TODO パターンClosure Compiler アノテーション、および TypeScript 構文 も認識し、コード補完、インテンションアクション、その他のコーディング支援で使用します。

JSDoc 入門(英語)および JSDoc でサポートされているタイプ(英語)の例を使用して、JSDoc 構文の詳細な説明を見つけてください。

JSDoc コメントを作成する

  • 文書化するメソッド / 関数またはフィールドの宣言の前にキャレットを置き、開始ブロックコメント /** を入力して、 Enter を押します。

    PyCharm は、該当する場合、パラメーター(@param )と戻り値(@returns )のリストを含む JSDoc コメントを生成します。 リストされたパラメーター、戻り値などを記述します。

    Generate jsdoc comment
  • あるいは、専用の Doc コメントの修正 アクションを使用します。 文書化するメソッド / 関数またはフィールドにキャレットを置き、 Ctrl+Shift+A を押して Fix Doc Comment の入力を開始します。 次に、リストから Doc コメントの修正 を選択し、 Enter を押します。

JSDoc コメントの TypeScript 構文

JavaScript ファイルの JSDoc コメント内で、TypeScript アノテーション(@type@typedef など)を使用できます。 PyCharm は TypeScript 構文構造、たとえば 共用体型@typedef 宣言のオプションプロパティを認識します。

PyCharm は TypeScript アノテーションのコード補完を提供します。

JavaScript ファイルの JSDoc 内の TypeScript アノテーション用のコード補完

@type アノテーションに基づいて、PyCharm はパラメーターヒントを表示します。

パラメーターのヒントは、JavaScript ファイルの JSDoc 内の型アノテーションに基づいて表示されます

エディターでレンダリングされた JSDoc コメントを表示する

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

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

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

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

    現在のファイルのすべてのコメントをレンダリングする
  • 必要に応じて、コンテキストメニューから フォントサイズの調整 を選択し、スライダーを使用してフォントサイズを変更します。

    フォントサイズを調整する
  • デフォルトでレンダリングされるすべての JSDoc コメントを表示するには、 設定 ダイアログ(Ctrl+Alt+S )を開き、 エディター | 一般 | 外観 に移動して、 Render documentation comments チェックボックスを選択します。

    レンダリングされた JSDoc コメントをデフォルトでオンにする
  • レンダリングビューのガターアイコンを非表示にするには、ガターのコンテキストメニューから Configure Gutter Icons… を選択し、開いた 設定 | エディター | 一般 | ガターアイコン ページの Documentation comments in-place rendering チェックボックスをオフにします。

2026 年 6 月 1 日