llms.txt: machine-readable documentation index. Markdown version of this page is also available.

CLion 2026.3 Help

JSDoc コメント

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

CLion also recognizes TODO patterns, Closure Compiler annotations, and TypeScript syntax inside documentation comments and uses them in code completion, intention actions, and other types of coding assistance.

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

JSDoc コメントを作成する

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

    CLion generates a JSDoc comment with a list of parameters (@param) and return values (@returns), where applicable. リストされたパラメーター、戻り値などを記述します。

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

JSDoc コメントの TypeScript 構文

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

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

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

Based on @type annotations, CLion shows parameter hints.

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

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

With CLion, JSDoc comments can be shown in an easier-to-read format. この レンダリングされたビューモードでは、アイテムは @ タグでグループ化されて表示されますが、タグ自体はスキップされます。 参照先の Web ページを開いて、参照先のトピックのクイックドキュメントを表示し、読みやすくするためにフォントサイズを調整できます。

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

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

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

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

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

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

2026 年 11 月 6 日