# JSDoc コメント

> For the complete documentation index, see [llms.txt](https://www.jetbrains.com/ja-jp/help/clion/llms.txt).

> **TL;DR**
> 必須プラグイン  ：
>
>
>
> `JavaScript and TypeScript` ：このプラグインは CLion にバンドルされており、デフォルトで有効化されています。

CLion は [JSDoc コメント](https://jsdoc.app/)を認識し、  `@param` 、  `@returns` 、  `@private` 、その他のタグを、開始ブロックコメント  `/**`  を入力して `Enter` (Windows), `⏎` (macOS), `⏎` (IntelliJ IDEA Classic (macOS)), `⏎` (macOS System Shortcuts), `Enter` (XWin), `Enter` (GNOME), `Enter` (KDE), `Enter` (Emacs), `Enter` (Sublime Text), `⏎` (Sublime Text (macOS)), `⏎` (Xcode), `Enter` (Visual Studio), `⏎` (Visual Studio (macOS)), `Enter` (ReSharper), `⏎` (ReSharper (macOS)), `Enter` (QtCreator), `⏎` (QtCreator (macOS)), `Enter` (NetBeans), `Enter` (Eclipse), `⏎` (Eclipse (macOS)) を押したときに自動的に挿入して、作成を支援します。 JSDoc コメントは、JavaScript および TypeScript で `Ctrl+Q` (Windows), `F1` (macOS), `⌃ J` (IntelliJ IDEA Classic (macOS)), `⌘ I` (macOS System Shortcuts), `Ctrl+Q` (XWin), `Ctrl+Q` (GNOME), `Ctrl+Q` (KDE), `Ctrl+Q` (Emacs), `Ctrl+Q` (Sublime Text), `Ctrl+Q` (Sublime Text (macOS)), `⌘ ⌃ ⇧ /` (Xcode), `Ctrl+K, I` (Visual Studio), `⌘ K, I` (Visual Studio (macOS)), `Ctrl+Q` (ReSharper), `⌃ Q` (ReSharper (macOS)), `Ctrl+Q` (QtCreator), `Ctrl+Q` (QtCreator (macOS)), `Ctrl+Q` (NetBeans), `Alt+Middle-Click` (Eclipse), `⌥ Middle-Click` (Eclipse (macOS)) を使ったドキュメント検索に使用されます。 [JavaScript ドキュメント検索](viewing-javascript-reference.html#view)と [TypeScript ドキュメント検索](typescript-support.html#ws_ts_documentation_look_up)を参照してください。また、チェーンメソッドの [型アノテーション](javascript-specific-guidelines.html#ws_js_type_hints)や [メソッドの戻り値の型ヒント](javascript-specific-guidelines.html#ws_js_return_type_hints)にも使用されます。

CLion also recognizes [TODO patterns](using-todo.html), [Closure Compiler](https://github.com/google/closure-compiler/wiki/Annotating-JavaScript-for-the-Closure-Compiler) annotations, and [TypeScript syntax](#ws_js_jsdoc_typescript_syntax) inside documentation comments and uses them in code completion, intention actions, and other types of coding assistance.

[JSDoc 入門(英語)](https://jsdoc.app/about-getting-started.html)および [JSDoc でサポートされているタイプ(英語)](https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html)の例を使用して、JSDoc 構文の詳細な説明を見つけてください。

## JSDoc コメントを作成する

Procedure:

* 文書化するメソッド / 関数またはフィールドの宣言の前にキャレットを置き、開始ブロックコメント  `/**`  を入力して、 `Enter` (Windows), `⏎` (macOS), `⏎` (IntelliJ IDEA Classic (macOS)), `⏎` (macOS System Shortcuts), `Enter` (XWin), `Enter` (GNOME), `Enter` (KDE), `Enter` (Emacs), `Enter` (Sublime Text), `⏎` (Sublime Text (macOS)), `⏎` (Xcode), `Enter` (Visual Studio), `⏎` (Visual Studio (macOS)), `Enter` (ReSharper), `⏎` (ReSharper (macOS)), `Enter` (QtCreator), `⏎` (QtCreator (macOS)), `Enter` (NetBeans), `Enter` (Eclipse), `⏎` (Eclipse (macOS)) を押します。

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

![Generate jsdoc comment](https://resources.jetbrains.com/help/img/idea/2026.3/ws_insert_jsdoc_comment.animated.gif)

> **Tip:**
> JSDoc コメントの自動生成をオフにするには、   設定   ダイアログ（ `Ctrl+Alt+S` (Windows), `⌘ Comma` (macOS), `⌘ Comma` (IntelliJ IDEA Classic (macOS)), `⌘ Comma` (macOS System Shortcuts), `Ctrl+Alt+S` (XWin), `Ctrl+Alt+S` (GNOME), `Ctrl+Alt+S` (KDE), `Ctrl+Alt+S` (Emacs), `Ctrl+Alt+S` (Sublime Text), `⌘ Comma` (Sublime Text (macOS)), `⌘ Comma` (Xcode), `Ctrl+Alt+S` (Visual Studio), `⌘ Comma` (Visual Studio (macOS)), `Ctrl+Alt+S` (ReSharper), `⌘ Comma` (ReSharper (macOS)), `Ctrl+Alt+S` (QtCreator), `⌘ Comma` (QtCreator (macOS)), `Ctrl+Alt+S` (NetBeans), `Ctrl+Alt+S` (Eclipse), `⌘ Comma` (Eclipse (macOS)) ）を開き、  `エディター | 一般 | スマートキー`  に移動して、   Enter   領域の   ドキュメントコメントスタブを挿入する   チェックボックスをオフにします。

* あるいは、専用の   Doc コメントを修正   アクションを使用します。 文書化するメソッド / 関数またはフィールドにキャレットを置き、 `Ctrl+Shift+A` (Windows), `⌘ ⇧ A` (macOS), `⌘ ⇧ A` (IntelliJ IDEA Classic (macOS)), `⌘ ⇧ P` (macOS System Shortcuts), `Ctrl+Shift+A` (XWin), `Ctrl+Shift+A` (GNOME), `Ctrl+Shift+A` (KDE), `Escape, X` (Emacs), `Ctrl+Shift+P` (Sublime Text), `⌘ ⇧ P` (Sublime Text (macOS)), `⌘ ⇧ A` (Xcode), `Ctrl+Shift+A` (Visual Studio), `⌘ ⇧ A` (Visual Studio (macOS)), `Ctrl+Shift+A` (ReSharper), `⌘ ⇧ A` (ReSharper (macOS)), `Ctrl+Shift+A` (QtCreator), `⌘ ⇧ A` (QtCreator (macOS)), `Ctrl+I` (NetBeans), `Ctrl+Shift+A` (Eclipse), `⌘ 3` (Eclipse (macOS)) を押して  `Doc コメントを修正`  の入力を開始します。 次に、リストから   Doc コメントを修正   を選択し、 `Enter` (Windows), `⏎` (macOS), `⏎` (IntelliJ IDEA Classic (macOS)), `⏎` (macOS System Shortcuts), `Enter` (XWin), `Enter` (GNOME), `Enter` (KDE), `Enter` (Emacs), `Enter` (Sublime Text), `⏎` (Sublime Text (macOS)), `⏎` (Xcode), `Enter` (Visual Studio), `⏎` (Visual Studio (macOS)), `Enter` (ReSharper), `⏎` (ReSharper (macOS)), `Enter` (QtCreator), `⏎` (QtCreator (macOS)), `Enter` (NetBeans), `Enter` (Eclipse), `⏎` (Eclipse (macOS)) を押します。

## JSDoc コメントの TypeScript 構文

JavaScript ファイルの JSDoc コメント内で、TypeScript アノテーション（  `@type`  や  `@typedef`  など）を使用できます。 CLion は、 [共用体型](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types)や  `@typedef`  宣言内のオプションのプロパティなど、TypeScript 構文構造を認識します。

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

![JavaScript ファイルの JSDoc 内の TypeScript アノテーション用のコード補完](https://resources.jetbrains.com/help/img/idea/2026.3/ws_jsdoc_ts_syntax_completion.png)

Based on  `@type`  annotations, CLion shows parameter hints.

![パラメーターのヒントは、JavaScript ファイルの JSDoc 内の型アノテーションに基づいて表示されます](https://resources.jetbrains.com/help/img/idea/2026.3/ws_jsdoc_ts_syntax_parameter_hints.png)

> **Note:**
> 混合タイプもサポートされています。 However, when JSDoc and TypeScript syntax are in contradiction, CLion uses JSDoc syntax.

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

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

![Rendered View for JSDoc comments](https://resources.jetbrains.com/help/img/idea/2026.3/ws_js_preview_jsdoc_comments_rendered_in_the_editor.animated.gif)

> **Tip:**
> レンダリングされたビュー モードは、JavaScript と TypeScript の両方で使用できます。

Procedure:

* レンダリングされたビュー モードに入るには、コメントの上にマウスを置き、余白の ![Toggle Rendered View アイコン](https://resources.jetbrains.com/help/img/idea/2026.3/app.gutter.javadocRead.svg) をクリックするか、 `Ctrl+Alt+Q` (Windows), `⌃ ⌥ Q` (macOS), `⌃ ⌥ Q` (IntelliJ IDEA Classic (macOS)), `⌃ ⌥ Q` (macOS System Shortcuts), `Ctrl+Alt+Q` (XWin), `Ctrl+Alt+Q` (GNOME), `Ctrl+Alt+Q` (KDE), `Ctrl+Alt+Q` (Emacs), `Ctrl+Alt+Q` (Sublime Text), `⌃ ⌥ Q` (Sublime Text (macOS)), `Ctrl+Alt+Q` (Xcode), `Ctrl+K, V` (Visual Studio), `⌘ K, V` (Visual Studio (macOS)), `Ctrl+Alt+Q` (ReSharper), `⌃ ⌥ Q` (ReSharper (macOS)), `Ctrl+Alt+Q` (QtCreator), `⌃ ⌥ Q` (QtCreator (macOS)), `Ctrl+Alt+Q` (NetBeans), `Ctrl+Alt+Q` (Eclipse), `⌃ ⌥ Q` (Eclipse (macOS)) を押します。 アイコンが ![Toggle Rendered View アイコン](https://resources.jetbrains.com/help/img/idea/2026.3/app.gutter.javadocEdit.svg) に変わります。

![レンダリングビューモードをオンにする](https://resources.jetbrains.com/help/img/idea/2026.3/turn_on_rendered_view.png)

* レンダリングされたビュー モードを終了するには、ガターで ![Toggle Rendered View アイコン](https://resources.jetbrains.com/help/img/idea/2026.3/app.gutter.javadocEdit.svg) をクリックするか、JSDoc コメントのコンテキストメニューから   レンダリングビューの切り替え   を選択するか、 `Ctrl+Alt+Q` (Windows), `⌃ ⌥ Q` (macOS), `⌃ ⌥ Q` (IntelliJ IDEA Classic (macOS)), `⌃ ⌥ Q` (macOS System Shortcuts), `Ctrl+Alt+Q` (XWin), `Ctrl+Alt+Q` (GNOME), `Ctrl+Alt+Q` (KDE), `Ctrl+Alt+Q` (Emacs), `Ctrl+Alt+Q` (Sublime Text), `⌃ ⌥ Q` (Sublime Text (macOS)), `Ctrl+Alt+Q` (Xcode), `Ctrl+K, V` (Visual Studio), `⌘ K, V` (Visual Studio (macOS)), `Ctrl+Alt+Q` (ReSharper), `⌃ ⌥ Q` (ReSharper (macOS)), `Ctrl+Alt+Q` (QtCreator), `⌃ ⌥ Q` (QtCreator (macOS)), `Ctrl+Alt+Q` (NetBeans), `Ctrl+Alt+Q` (Eclipse), `⌃ ⌥ Q` (Eclipse (macOS)) を押します。

![レンダリングビューモードをオフにする](https://resources.jetbrains.com/help/img/idea/2026.3/turn_off_rendered_view.png)

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

![現在のファイルのすべてのコメントをレンダリングする](https://resources.jetbrains.com/help/img/idea/2026.3/render_all_comments.png)

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

![フォントサイズを調整する](https://resources.jetbrains.com/help/img/idea/2026.3/adjust_font_size.png)

* デフォルトでレンダリングされるすべての JSDoc コメントを表示するには、   設定   ダイアログ（ `Ctrl+Alt+S` (Windows), `⌘ Comma` (macOS), `⌘ Comma` (IntelliJ IDEA Classic (macOS)), `⌘ Comma` (macOS System Shortcuts), `Ctrl+Alt+S` (XWin), `Ctrl+Alt+S` (GNOME), `Ctrl+Alt+S` (KDE), `Ctrl+Alt+S` (Emacs), `Ctrl+Alt+S` (Sublime Text), `⌘ Comma` (Sublime Text (macOS)), `⌘ Comma` (Xcode), `Ctrl+Alt+S` (Visual Studio), `⌘ Comma` (Visual Studio (macOS)), `Ctrl+Alt+S` (ReSharper), `⌘ Comma` (ReSharper (macOS)), `Ctrl+Alt+S` (QtCreator), `⌘ Comma` (QtCreator (macOS)), `Ctrl+Alt+S` (NetBeans), `Ctrl+Alt+S` (Eclipse), `⌘ Comma` (Eclipse (macOS)) ）を開き、  `エディター | 一般 | 外観`  に移動して、   ドキュメントコメントをレンダリングする   チェックボックスを選択します。

![レンダリングされた JSDoc コメントをデフォルトでオンにする](https://resources.jetbrains.com/help/img/idea/2026.3/ws_js_preview_jsdoc_comments_rendered_checkbox.png)

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

## See also

### プロシージャ

[クイックドキュメント](viewing-inline-documentation.html)

### リファレンス

[インスペクション](inspections-settings.html)

### 外部リンク

[https://github.com/jsdoc3/jsdoc/](https://github.com/jsdoc3/jsdoc/) [JSDoc toolkit](https://code.google.com/p/jsdoc-toolkit/) [Google Closure Compiler](https://github.com/google/closure-compiler/wiki/Annotating-JavaScript-for-the-Closure-Compiler)

