# Doxygen 文档

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

[Doxygen](http://www.doxygen.nl) 风格的注释可以分布在源代码中，并用于生成各种格式的完整文档。

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-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)

## 输入辅助

CLion 的 [自动完成](auto-completing-code.html) 功能提供了对 [Doxygen 命令](https://www.doxygen.nl/manual/commands.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 注释可以以更易于阅读的格式显示。 在此  渲染视图  模式下，项目按其标签分组显示，而标签本身被省略。

![切换 Doxygen 注释的渲染视图](https://resources.jetbrains.com/help/img/idea/2026.3/cl_toggle_rendered_view.animated.gif)

请注意渲染视图的限制：

* 无法打开引用的网页。

* 仅当 EOL 块注释位于行首时才会被渲染。

Procedure: 切换并配置渲染视图

* 进入  渲染视图 模式，请将鼠标悬停在评论上并点击 ![切换渲染视图图标](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))。 图标变成 ![切换渲染视图图标](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)

* 要退出  渲染视图  模式，请点击边栏中的 ![切换渲染视图图标](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 注释启用  渲染视图  模式，请从边栏的上下文菜单中选择   渲染全部文档注释  。

![为所有 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)

* 要隐藏 Rendered View 槽图标，请从槽的上下文菜单中选择   配置装订区域图标…  ，然后在打开的  `设置 | 编辑器 | 常规 | 栏标图标`  页面上取消选择   文档注释就地渲染   复选框。

## 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)

