快速入门指南
0.开始之前 在开始之前
CLion 是跨平台的 IDE 吗？
是的，您可以在 Windows、macOS 和 Linux 上安装并运行 CLion。
请参阅 安装 CLion 以获取特定操作系统的说明。
有关为您的操作系统选择合适的键位图和学习最有用的快捷键的更多信息，请参阅 CLion 键盘快捷键。
我可以使用哪些编译器和调试器？
在 CLion 中，您可以使用基于 GCC 的编译器、 Clang、 Clang-cl、 Visual Studio C++ 编译器 ，以及 IAR 编译器 和 自定义定义的编译器。 有关更多信息，请参阅 编译器。
CLion 支持在所有平台上使用 GDB （捆绑或自定义）进行调试，并在 macOS 和 Linux 上使用捆绑的 LLDB。 此外，在 Windows 上还有一个基于 LLDB 的 MSVC 工具链调试器。 有关更多信息，请参阅 调试部分 和 调试器选项 页面。
支持哪些构建系统？ 项目格式有哪些？
CLion 完全集成了 CMake 构建系统：您可以无缝地创建、打开、构建和运行/调试 CMake 项目。 CMake 本身已捆绑在 CLion 中，因此除非您决定使用自定义版本，否则无需单独安装。
除了 CMake，CLion 还支持 Makefile、 Meson、 编译数据库 和 Gradle 项目。 请注意，这些项目类型尚不支持新建项目向导。
有关更多信息，请参阅 项目格式。
我需要提前安装什么吗？
在 Windows 上，CLion 需要一个工作环境。 CLion 捆绑了一个 MinGW 工具集版本以便快速设置。 您可以使用此捆绑的工具链或切换到其他 MinGW 安装、Cygwin 或 Microsoft Visual C++。 如果您使用 WSL 或 Docker，则还需要安装它们。
有关更多信息，请参阅我们的 Windows 教程。
在 macOS 上，所需工具可能已经安装。 如果没有，请按照 在 macOS 上配置 CLion 中的说明更新 命令行开发者工具。
在 Linux 上，编译器和 make 也可能已预安装。 否则，对于 Debian/Ubuntu，请安装 构建_essentials 包，并在需要时安装 llvm 包以获取 Clang。
是否也支持 C++ 以外的语言？
是的，CLion 完全支持 Python、 Objective-C/C++ 、HTML（包括 HTML5）、CSS、JavaScript 和 XML。 对这些语言的支持通过捆绑的插件实现，这些插件默认启用。 如需更多信息，请参阅 CLion 功能支持多种语言。
您可以安装其他插件以在 CLion 中支持更多语言（例如， Markdown）。 从 有价值的语言插件 文章中了解更多关于插件的信息。
1. 打开/创建项目
打开本地项目
使用以下选项之一：
选择 文件 | 打开 并定位到项目目录。
此目录应包含一个 CMakeLists.txt 文件。
选择 文件 | 打开 并将 CLion 指向顶层 CMakeLists.txt 文件，然后点击 作为项目打开。
选择 文件 | 打开 并定位到 CMakeCache.txt 文件，然后点击 作为项目打开。
从主菜单中选择 。
将 CLion 指向包含顶层 Makefile 的文件夹或 Makefile 本身（在这种情况下，请在下一步中点击 作为项目打开）。
从主菜单中选择 。
将 CLion 指向包含 meson.构建 的文件夹并点击 打开。
请选择 从主菜单。
将 CLion 指向包含 compile_commands.json 的文件夹或 compile_commands.json 本身（在这种情况下，请在下一步中点击 作为项目打开）。
请选择 从主菜单。
将 CLion 指向包含 构建.gradle 的文件夹或 构建.gradle 文件本身（在这种情况下，请在下一步中点击 作为项目打开）。
克隆存储库
点击 从 VCS 获取 在欢迎屏幕上或选择 Git（或您的 VCS）| 克隆。
输入访问存储的凭据并提供源代码路径。
创建一个新的 CMake 项目
从主菜单中选择 或在欢迎屏幕上点击 新项目。
设置您的项目类型：C 或 C++，可执行文件或库。
请注意， STM32CubeMX 和 CUDA 也是基于 CMake 的项目类型。
提供根文件夹位置并选择 语言标准。
CLion 创建一个新的 CMake 项目并填写顶层 CMakeLists.txt ：
初始 CMakeLists.txt 文件已经包含几个命令。 在我们的 教程 中查找它们的描述和有关使用 CMake 的更多信息。
2. 环顾四周
任何时候您需要查找 IDE 操作时，按 Ctrl+Shift+A 或转到主菜单中的 并开始键入您正在寻找的命令、设置或 UI 元素的名称：
3. 自定义您的环境
更改 IDE 外观
在 IDE 中快速切换 配色方案、 代码样式、 键位映射、 查看模式 和外观（UI 主题 ）的方法是使用 切换... 弹窗。
要调用它，请点击 或按 Ctrl+`：
要探索所有可自定义选项，请转到 Ctrl+Alt+S 中的专用页面。
调整代码编辑器
对话框的 编辑器 节点下的页面可帮助您调整编辑器的行为，从最常规的设置（如启用拖放和滚动配置）到高亮颜色和代码样式选项。
代码样式可以在 节点下的页面中为每种语言单独配置。 对于 C/C++ ，您可以设置一个 预定义代码样式 或提供您自己的，并配置所需的 命名约定 ，包括 头文件保护 模板：
调整键位映射
在 CLion 中，几乎每个在 IDE 中可能的操作都映射到一个键盘快捷键。 要查看默认映射，请调用 。
您可以在 中自定义快捷键。 使用一个预定义的键位映射（Visual Studio、Emacs、Eclipse、NetBeans、Xcode 等）并根据需要调整，或者从头开始创建您自己的键位映射。
还有一些插件可以扩展可用键位映射的列表。 例如， VS Code 键位映射 或 Vim 仿真 （包括 Vim 键位映射）。 在 有价值的非捆绑插件 中查找更多对 CLion 编辑器有用的插件。
4。 辅助编码
自动补全
CLion 中的补全 Ctrl+Space 会在您键入时工作，并提供所有可用补全的列表。 要筛选此列表并仅查看与预期类型匹配的建议，请使用 智能补全 Ctrl+Shift+Space：
补全以及其他代码洞察功能也适用于 CMake 代码。 参见 CMakeLists.txt 的编码辅助。
代码生成
即使是一个空类或一个新的 C/C++ 文件也包含样板代码，这些代码由 CLion 自动生成。 例如，当您添加一个新类时，CLion 会创建一个包含存根代码和头文件保护的头文件，以及一个包含它的相应源文件。
最有用的代码生成功能之一是 从用法创建。 它帮助您专注于想法的产生，并处理例行工作。
例如，当您调用一个尚未实现的函数时，无需中断流程：按 Alt+Enter 生成存根代码，您可以稍后再回来处理。 从使用中创建 也适用于变量和类：
要在代码中的任何位置获取代码生成选项列表，请按 Alt+Insert 调用 生成 菜单：
这些选项可以帮助您跳过大量代码编写。 除了生成构造函数/析构函数、getter/setter 和各种运算符之外，您还可以快速重写和实现函数：
实时模板 是生成整个代码结构的工具。 在 中查找可用模板的列表。 要将模板粘贴到代码中，请调用 或按 Ctrl+J ，例如：
之前 | 之后 |
|---|---|
 |  |
要快速将代码包围在循环和条件语句中，例如 if、 while、 for、 #ifdef ，请调用 或按 Ctrl+Alt+T：
之前 | 之后 |
|---|---|
 |  |
意图和快速修复
当您在代码中的符号旁边看到一个灯泡时，这意味着 CLion 的代码分析发现了一个潜在问题或可能需要进行的更改：
表示一个错误，并允许您选择快速修复它，
表示有一个或多个 意图操作 可用。
点击灯泡图标（或按 Alt+Enter ）并选择最合适的操作或快速修复：
快速修复 | 意图操作 |
|---|---|
 |  |
检查
在即时代码分析期间，CLion 会高亮显示可疑代码，并在右侧边栏显示彩色条纹。 您可以将鼠标悬停在条纹上查看问题描述，并点击它跳转到相应的问题。 边栏顶部的标志指示整个文件的状态：
CLion 不仅检测编译错误，还检测代码低效问题，例如未使用的变量或无效代码。 此外，它还集成了一组可自定义的 Clang-tidy 检查。
要启用或禁用检查，配置其严重级别（检查是否应引发错误或仅显示为警告）并设置作用域，请转到 。
您还可以按需对整个项目或自定义作用域运行检查，并在单独的窗口中查看结果。 为此，请调用 或对特定检查使用 Ctrl+Alt+Shift+I。
在结果工具窗口中，您可以一次性批量应用多个问题的快速修复。 在描述选项卡中点击 部分修复：
重构
重构 有助于改进代码，而无需添加新功能，使其更清晰、更易于阅读和维护。 使用主菜单的 重构 部分或调用 重构此... Ctrl+Alt+Shift+T 获取当前位置可用的重构列表：
例如：
5. 探索您的代码
全局搜索
要在 CLion 中搜索任何内容，无论是代码库中的项目、操作还是 UI 元素，请按
Shift
两次，然后在 随处搜索 对话框中开始键入您要查找的内容。 使用筛选器 
菜单缩小搜索作用域：
查找用法
要定位任何代码符号的用法，请调用 查找用法 （Alt+F7 或 ）。 您可以筛选结果并跳回源代码：
在代码结构中导航
在头文件和源文件之间切换 F10
转到声明/定义 Ctrl+B Ctrl+Alt+B
显示文件结构 Alt+7
查看类型层次结构 Ctrl+H
查看调用层次结构 Ctrl+Alt+H
查看导入层次结构 Alt+Shift+H
对于您的代码，CLion 构建了类型、调用、导入和函数的 层次结构。 要查看它们，请使用上面给出的快捷键或 菜单中的命令。 例如，类型层次结构不仅有助于导航代码，还可以发现代码库中存在的类型关系：
要探索当前打开文件的结构，请调用 或按 Alt+7：
此外，使用左侧边栏图标快速跳转到声明/定义或浏览类层次结构（
/
， 
/
）。
查看弹出文档
快速文档 弹窗（可通过鼠标悬停或 Ctrl+Q 快捷键调用）帮助您在不离开当前上下文的情况下获取光标处符号的更多信息。 根据您调用它的元素，弹窗显示：
函数签名 详细信息，
代码文档 （常规或 Doxygen 注释），
推断类型 用于声明为
auto的变量：
格式化的 宏展开：
此外，您可以立即查看光标处符号的定义。 按 Ctrl+Shift+I 调用 快速定义 弹窗：
6。 构建并运行
运行单个文件
如果您只有一两个文件需要编译和运行，则无需使用项目模型：您的文件可以直接编译和运行/调试。
在编辑器中，点击程序入口点旁边的左侧边栏图标并选择操作：
运行/调试配置
对于项目中的每个目标，CLion 会创建一个 运行/调试配置。 这是一个命名设置，包括目标、可执行文件、传递给程序的参数以及其他选项。
运行/调试配置是从 templates 生成的，例如 CMake 应用程序、 Google 测试、 远程 GDB 调试 等。 这些模板是可自定义的：当您编辑模板参数时，您会更改以后从该模板创建的所有配置的默认设置。
对话框可从 运行 菜单或配置切换器中访问。 在这里，您可以管理模板并添加、删除或编辑您的配置。
例如，您可以自定义 启动前 的步骤：调用 外部工具 （包括远程工具）、使用 CMake 安装 ，甚至运行另一个配置。
要启动您的程序，请选择所需的配置并使用 
运行 菜单中的命令或按 Shift+F10。 或者，通过按
Ctrl
两次调用 运行任意内容 对话框并开始键入配置名称：
构建操作
构建 被包含在许多运行/调试配置模板中，作为默认的启动前步骤。 但是，您也可以通过从 构建 菜单中调用所需的 操作 单独执行它：
注意 重新编译 选项，它可以在不构建整个项目的情况下编译选定的文件。
远程和嵌入式开发
7。 调试
CLion 在所有平台上与 GDB 后端集成（在 Windows 上，捆绑的 GDB 仅适用于 MinGW ）以及在 macOS/Linux 上与 LLDB 集成。 您可以在所有平台上切换到自定义版本的 GDB。 此外，CLion 为 Windows 上的 MSVC 提供了一个 基于 LLDB 的调试器。
目前，捆绑调试器的版本如下：
LLDB v19.1.3（适用于 macOS/Linux）和 9.0.0（适用于 Windows（MSVC））
GDB v15.2（适用于 Windows）
Linux 的 GDB v15.2
自定义 GDB v7.8.x-14.1
要开始调试会话，请选择所需的配置并按 Shift+F9 或点击 
。 您可以通过点击代码行旁边的边栏来设置 断点。 要跟踪执行过程，请使用调试器的 单步操作：
在调试器工具窗口的 变量 选项卡中，您可以探索值并在不中断调试会话的情况下更改它们。 要评估表达式，请按 Alt+F8。 CLion 还会直接在编辑器中显示当前变量的值，如果您启用了 十六进制视图 ，它也会内联显示：
有用的调试器快捷键 | |
|---|---|
切换断点 | Ctrl+F8 |
查看断点详细信息/所有断点 | Ctrl+Shift+F8 |
逐步跳过 | F8 |
逐步进入 | F7 |
停止 | Ctrl+F2 |
恢复程序 | F9 |
在插入符号处调试代码 | Shift+F9 在 |
此外，您可以单步进入 反汇编 ，调用 内存 视图、 附加到本地进程 ，并使用 GDB/gdbserver 进行远程调试。
8。 运行时分析
某些漏洞和错误只能在程序执行期间暴露：内存泄漏、未初始化的访问、并发问题、未定义行为等。
为了帮助您捕获运行时问题，CLion 集成了 Valgrind Memcheck 和 Google Sanitizers。
此外，您还可以使用内置的 CPU 分析器 分析应用程序性能，并测量 代码覆盖率。 对于这些工具，CLion 提供了可视化输出和便捷功能，例如导入/导出分析结果的选项。
Valgrind、Sanitizers 和分析器的设置位于 下。
有关更多信息，请参阅关于 动态代码分析 的部分。
Valgrind Memcheck
Valgrind Memcheck 在 CLion 中通过 WSL 支持在 Linux、macOS 和 Windows 上运行。 您需要 安装 Valgrind，将 CLion 指向二进制文件，设置分析标志，然后使用 或按 
运行程序。
Google Sanitizers
Google Sanitizers 在 Linux 上支持某些版本的 Clang 和 GCC。 请查看我们关于在 CLion 中使用 Sanitizers 的详细 指南。
CPU 分析器
CLion 的 分析器 可用于 Linux 和 macOS，收集应用程序用户代码和内核代码的性能数据。 分析器收集性能指标并以火焰图和统计视图的形式可视化它们。 要运行它，请调用 或使用 
按钮。
代码覆盖率
CLion 中的 代码覆盖率 集成基于 llvm-cov/gcov 工具，适用于 CMake 应用程序和测试。 覆盖率结果显示在一次启动期间每个文件夹的文件百分比和每个文件的行覆盖率。 要获取覆盖率测量值，请设置必要的 编译器标志 并调用 或点击 
。
9。 添加单元测试
CLion 支持 Google Test、 Boost.Test、 Catch(2)、 CTest 和 Doctest 测试框架，配备内置测试运行器和专用的运行/调试配置。 对于链接了 gtest 或 gmock 的 CMake 目标，CLion 会自动创建 Google Test 配置。
运行测试与运行常规可执行文件类似：CLion 将指定的测试类或方法传递给测试运行器。 测试运行器显示进度条、输出流和运行测试的树视图，并指示其状态和持续时间：
您可以重新运行特定测试、所有测试或仅重新运行失败的测试 
，导出测试结果并从历史记录中打开以前的结果。
左侧边栏的图标帮助您快速运行/调试测试并检查测试状态，成功 
或失败 
：
10。 将其置于版本控制之下
版本控制系统
CLion 集成了多个 版本控制系统 ：Git（或 GitHub）、Mercurial、Perforce 和 Subversion。 要管理特定版本控制系统的设置，请转到 。
使用 版本控制系统操作弹窗 （Alt+` 或 ）调用版本控制命令。 此弹窗中的操作列表包括当前启用的版本控制系统和 本地历史记录。 例如：
未启用 VCS | 启用 VCS |
|---|---|
 |  |
您可以在主菜单的 VCS 部分找到所有可用的版本控制系统命令。 此外，一些基本命令可以从工具栏访问：
本地历史记录
除了完整的版本控制，您还可以通过浏览 本地历史记录 ，逐步回顾更改。 要查看文件或文件夹的本地历史记录，请调用 。 在这里，您可以还原更改并创建补丁：
11. 了解更多
我们希望这份 CLion 基础知识的简要概述能帮助您快速入门。 要深入了解，请查看 webhelp 中的其他文章和部分，例如：
有关新闻和实用提示，请查看我们的 推特 和 CLion 博客。
欢迎随时在 社区论坛 提问，并在 CLion 问题跟踪器 中报告问题。