JetBrains Rider 2025.2 Help

Doxygen 文档

Doxygen 风格的注释可以分布在源代码中,并用于生成各种格式的完整文档。

JetBrains Rider 将 Doxygen 的信息包含在 快速文档 弹出窗口 Ctrl+Q 中:

快速文档中的 Doxygen 注释

查看 Doxygen 文档

文档注释中的信息会包含在 快速文档 弹出窗口中,除了类型信息之外。 要调用文档弹出窗口:

  1. 将插入符号放在 Doxygen 注释的目标符号上。

  2. 请按 Ctrl+Q.

或者,当选中复选框 悬停时显示快速文档文件 | 设置 | 编辑器 | 代码编辑 )时,您只需将鼠标指针移动到目标符号上即可。

如果函数参数的文档与函数描述分开记录,JetBrains Rider 会合并所有注释,并向您显示完整的函数签名文档(与 Doxygen 生成输出时的方式相同)。

创建 Doxygen 注释

从头开始创建 Doxygen 注释:

  1. 输入以下符号之一: /////!/**/*! ,然后按下 Enter

  2. 您将获得一个用于填写文档文本的模板:

    生成注释

您还可以使用 文档实体 上下文操作。 如果需要,您可以通过 编辑 JetBrains Rider 用于生成的 doc 动态模板来自定义注释模板。

可靠的重命名

在重命名函数或其参数时,需要相应更新文档注释。 在 重命名重构 Shift+F6 的情况下,JetBrains Rider 会与其他引用一起更新文档注释。

之前:

重命名示例 - 之前

之后:

重命名示例 - 之后

Doxygen 注释颜色

要配置 Doxygen 注释中使用的颜色,请转到 设置 | 编辑器 | 配色方案 | C/C++ 并打开 注释 | Doxygen 节点:

Doxygen 注释颜色
最后修改日期: 2025年 9月 26日