代码文档

通过支持著名的 Doxygen 格式管理您的代码。

Doxygen 预览

预览文档

在 Quick Documentation（快速文档）弹出窗口 (Ctrl+Q) 中查看 Doxygen 文档预览。 除了类型信息之外，还可以按照整洁的方式解析和排列 Doxygen 命令。

如果函数参数与函数说明单独记录，CLion 将合并所有注释并为您显示完整函数的签名文档（与 Doxygen 生成输出时的行为一致）。

Doxygen 重命名

安全重命名

为保持文档正确性，请使用 Rename 重构 Shift+F6 来更新函数名或其参数。 CLion 将更新 Doxygen 注释和其他引用。

Doxygen 补全

使用补全

为了提高您的输入速度，CLion 附带 Doxygen 命令和函数参数的自动补全功能。

Doxygen 注释生成

生成文档

要为函数添加新的 Doxygen 注释，只要生成它即可。 输入 /**, /*!， /// 或 //!，然后按下 Enter。 程序会为您生成存根，以防您的函数有参数，返回值或出现异常。

快速文档

快速文档

Quick Documentation popup (Ctrl+Q) is a universal tool to help you get more information on a code element at the caret. CLion 默认会在鼠标悬停时自动在弹出窗口中显示快速文档。 根据调用的元素，弹出窗口可以包括：
  • 函数签名详细信息。
  • 代码文档（常规或 Doxygen 注释）。
  • 推断类型，尤其适合可能缺少显式类型的现代 C++。
  • 类型的大小。
  • 宏替换有助于您更好地理解和调试嵌套宏。
  • 常量表达式的值。
  • 作为整数的 Enum 值。