# Doxygen のドキュメント

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

[Doxygen(英語)](http://www.doxygen.nl) -style コメントはソースコード全体に配置でき、さまざまな形式で本格的なドキュメントを生成するために使用できます。

CLion は doxygen からの情報を   クイックドキュメント   ポップアップ `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)) に組み込みます：

![クイックドキュメントの Doxygen コメント](https://resources.jetbrains.com/help/img/idea/2026.3/cl_doxygen.png)

## doxygen ドキュメントの表示

型情報に加えて、   クイックドキュメント   ポップアップには Doxygen スタイルの情報が含まれています。 ドキュメントポップアップを呼び出すには

Procedure:

1. キャレットを目的のシンボル、または doxygen コメントの  `@param`  コマンドに置きます。

2. `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)) を押します。

あるいは、チェックボックス   ホバー時にクイックドキュメントを表示する   (  `設定 | エディター | 一般 | その他`  ) が選択されている場合は、マウスポインターを目的のシンボルの上に移動するだけです。

関数パラメーターが関数説明とは別にドキュメント化されている場合、CLion はすべてのコメントをマージし、完全な関数のシグネチャーのドキュメントを表示します（doxygen が出力を生成するときと同じ方法です）：

![統合された Doxygen コメント](https://resources.jetbrains.com/help/img/idea/2026.3/cl_doxygen_2.png)

## doxygen コメントの作成

doxygen コメントを最初から作成するには:

Procedure:

1. 次のいずれかのシンボル:  `///` 、  `//!` 、  `/**` 、または  `/*!`  を入力し、 `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)) を押します。

2. ドキュメントテキストを入力するためのスタブが表示されます:

![コメントの生成](https://resources.jetbrains.com/help/img/idea/2026.3/cl_doxygen_stub.png)

Procedure:

接頭辞タイプを変更するか、  `@brief`  タグを追加するには:

1. `設定 | 言語 & フレームワーク | C/C++ | コード生成`  に進みます。

2. ドキュメントコメントテンプレート   セクションまでスクロールします。

![Doxygen コメント設定](https://resources.jetbrains.com/help/img/idea/2026.3/cl_doxygen_comments_settings_nova.png)

## 信頼できる名前変更

関数またはそのパラメーターの名前を変更するときは、それに応じて doxygen コメントを更新する必要があります。 [Rename](rename-refactorings.html) リファクタリング `Shift+F6` (Windows), `⇧ F6` (macOS), `⇧ F6` (IntelliJ IDEA Classic (macOS)), `⌘ ⌥ R` (macOS System Shortcuts), `Shift+F6` (XWin), `Shift+F6` (GNOME), `Shift+F6` (KDE), `Shift+F6` (Emacs), `Shift+F6` (Sublime Text), `⇧ F6` (Sublime Text (macOS)), `⌘ ⌃ E` (Xcode), `Ctrl+R, R` (Visual Studio), `⌘ R, R` (Visual Studio (macOS)), `F2` (ReSharper), `F2` (ReSharper (macOS)), `Ctrl+Shift+R` (QtCreator), `⌘ ⌃ R` (QtCreator (macOS)), `Ctrl+R` (NetBeans), `Alt+Shift+R` (Eclipse), `⇧ F6` (Eclipse (macOS)) の場合、CLion は他の参照とともに doxygen コメントを更新します。

次の前で改ページ:

![名前変更の例 - 前](https://resources.jetbrains.com/help/img/idea/2026.3/cl_dox_rename_before.png)

次の後で改ページ:

![名前変更の例 - 後](https://resources.jetbrains.com/help/img/idea/2026.3/cl_dox_rename_after.png)

## 入力支援

[doxygen コマンド](https://www.doxygen.nl/manual/commands.html)の基本的な入力支援は、CLion [auto-complete](auto-completing-code.html) 機能によって提供されます：

![doxygen コマンドの入力支援](https://resources.jetbrains.com/help/img/idea/2026.3/cl_dox_codecompletion.png)

補完ですべてのコマンドが使用できるわけではないことに注意してください。 [ここ](https://youtrack.jetbrains.com/issue/CPP-6723)に現在サポートされていないコマンドのリストがあります。

## doxygen コメントのレンダリングされたビュー

CLion を使うと、doxygen コメントをより見やすいフォーマットで表示できます。 この  レンダリングされたビュー モードでは、アイテムはタグごとにグループ化されて表示されますが、タグ自体はスキップされます。

![Toggling rendered view for doxygen comments](https://resources.jetbrains.com/help/img/idea/2026.3/cl_toggle_rendered_view.animated.gif)

レンダリングされたビューの制限に注意してください。

* 参照されている Web ページを開くことはできません。

* EOL ブロックのコメントは、行の先頭にある場合にのみレンダリングされます。

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/cl_doxygen_render_gutter.png)

* レンダリングされたビュー モードを終了するには、ガターの ![Toggle Rendered View アイコン](https://resources.jetbrains.com/help/img/idea/2026.3/app.gutter.javadocEdit.svg) をクリックするか、doxygen コメントのコンテキストメニューから   レンダリングビューの切り替え   を選択するか、 `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/cl_doxygen_render_quit.png)

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

![すべての doxygen コメントのレンダリングビューを有効にする](https://resources.jetbrains.com/help/img/idea/2026.3/cl_doxygen_render_all.png)

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

![レンダリングビューでのフォントサイズの調整](https://resources.jetbrains.com/help/img/idea/2026.3/cl_doxygen_render_adjustfont.png)

* デフォルトで表示されるすべての doxygen コメントを表示するには、   設定   ダイアログ ( `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)) ) を開き、  `エディター | 一般 | 外観`  に移動して、   ドキュメントコメントをレンダリングする   チェックボックスを選択します。

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

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

## Doxygen コメントの色

doxygen コメントで使用される色を構成するには、  `設定 | エディター | カラースキームの切り替え | C/C++`  に移動し、  `コメント | Doxygen`  ノードを開きます。

![Doxygen コメントの色](https://resources.jetbrains.com/help/img/idea/2026.3/C++](code-style-c-c.html) [Editor. Appearance](settings-editor-appearance.html)

