# CMakeLists.txt

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

`CMakeLists.txt`  文件包含一组描述项目源文件和目标（可执行文件、库或两者）的指令和说明。

当您 [创建一个新项目](creating-new-project-from-scratch.html)时，CLion 会自动生成  `CMakeLists.txt`  文件并将其放置在项目根目录中。 要 [打开](creating-new-project-from-scratch.html#open-prj)一个项目，您可以将 CLion 指向顶层  `CMakeLists.txt`  并选择   作为项目打开  。

以下示例显示了一个简单的 "Hello, World" 项目的  `CMakeLists.txt`  文件：

```CMAKE
cmake_minimum_required(VERSION 3.20)  # CMake version check
project(simple_example)               # Create project "simple_example"
set(CMAKE_CXX_STANDARD 14)            # Enable c++14 standard

# Add main.cpp file of the project root directory as a source file
set(SOURCE_FILES main.cpp)

# Add executable target with source files listed in SOURCE_FILES variable
add_executable(simple_example ${SOURCE_FILES})

```

> **Note:**
> 不支持早于 3.15. 的 CMake 版本。 如果从捆绑的 CMake 切换到自定义安装，请确保其版本为 3.15. 或更高。

您可以直接在编辑器中编辑  `CMakeLists.txt`  文件。 请确保在编辑后 [重新加载](reloading-project.html)项目。 自动重新加载功能默认是禁用的，您可以通过在  `设置 | 构建、执行、部署 | CMake`  中勾选   编辑时自动重新加载 CMake 项目   复选框来启用它。

## 子目录 CMakeLists.txt 文件

对于结构复杂的项目，您可以创建子目录  `CMakeList.txt`  文件来描述子项目的构建、内容和目标规则。

子目录  `CMakeLists.txt`  添加的目标类型可能会根据模块的角色而有所不同。

![子目录中的 CMakeLists.txt 文件](https://resources.jetbrains.com/help/img/idea/2026.3/cl_cmakeListsFiles.png)

## CMakeLists.txt 文件模板

当您通过新建项目向导创建 CMake 或基于 CMake 的（ [CUDA](cuda-projects.html)、 [Qt](qt-tutorial.html)）项目时，CLion 会根据项目类型和设置使用不同模板来生成  `CMakeLists.txt` 。 您可以在  `设置 | 编辑器 | 文件和代码模板`  的   其他   选项卡中微调这些模板：

![新建 CMake 项目的文件模板](https://resources.jetbrains.com/help/img/idea/2026.3/cl_cmake_templates_newprj.png)

编辑模板文本时，您可以使用常见的 [预定义变量](file-template-variables.html)和以下 CMake 特定变量：

|  ${CMAKE_DEFAULT_PROJECT_FILE}  |  项目的  `main.cpp` /  `main.c` /  `libary.cpp` /  `library.c`  文件。  |
|  ${CMAKE_LANGUAGE_VERSION}  |  所选的语言标准。  |
|  ${CMAKE_MAJOR_VERSION}  |  最低支持的 CMake 版本的主版本号。 例如，如果版本为  `3.20` ，此变量对应于  `3` 。  |
|  ${CMAKE_MINOR_VERSION}  |  最低支持的 CMake 版本的次版本号。 例如，如果版本为  `3.20` ，此变量对应于  `20` 。  |
|  ${CMAKE_LIBRARY_TYPE}  |  共享库的  `SHARED` 。  |
|  ${QT_VERSION}  |  所选的 Qt 版本。  |
|  ${REQUIRED_LIBS}  |  所选项目类型所需的 Qt 库。 默认情况下，它们是 Qt 控制台可执行文件的  `Core`  和 Qt 窗口小部件可执行文件的  `Core` 、  `Gui` 、  `Widgets` 。  |

此外，还有一个用于 CMake 脚本的模板，您可以通过项目视图上下文菜单中的  `新建 | CMakeLists.txt`  将其添加到现有项目中。 默认情况下，此模板为空。 您可以在  `设置 | 编辑器 | 文件和代码模板`  的   个文件   选项卡中使用相同的变量编辑它：

![新建 CMakeLists.txt 文件的文件模板](https://resources.jetbrains.com/help/img/idea/2026.3/cl_cmake_template_newcmakelists.png)

## CMakeLists.txt 的编码辅助

### 代码补全

CLion 为您的  `CMakeLists.txt`  中的大多数元素提供代码补全。 例如，在编写  `find_package()`  命令时，您可以获取 CMake 捆绑的包列表：

![CMake 中的补全](https://resources.jetbrains.com/help/img/idea/2026.3/cl_cmake_findpackage_completion.png)

### CMake 最低版本的快速修复

您可以快速调整 CMake 的最低要求版本。 在 CMake 输出中找到警告并点击   修复  ：

![CMake 最低版本的快速修复](https://resources.jetbrains.com/help/img/idea/2026.3/cl_cmake_version_quickfix.png)

CLion 将更改  `cmake_minimum_required()`  命令中的版本：

![CMake 最低版本已更改](https://resources.jetbrains.com/help/img/idea/2026.3/cl_cmake_version_fixed.png)

### 通过生成菜单添加目标

Procedure:

1. 按 `Alt+Insert` (Windows), `⌘ N` (macOS), `⌃ N` (IntelliJ IDEA Classic (macOS)), `⌘ N` (macOS System Shortcuts), `Alt+Insert` (XWin), `Alt+Insert` (GNOME), `Alt+Insert` (KDE), `Alt+Insert` (Emacs), `Alt+Insert` (Sublime Text), `⌘ N` (Sublime Text (macOS)), `⌘ N` (Xcode), `Alt+Insert` (Visual Studio), `⌘ ⌃ N` (Visual Studio (macOS)), `Alt+Insert` (ReSharper), `⌘ ⌃ N` (ReSharper (macOS)), `Alt+Insert` (QtCreator), `Alt+Insert` (QtCreator (macOS)), `Alt+Insert` (NetBeans), `Alt+Insert` (Eclipse), `⌘ N` (Eclipse (macOS)) 并选择目标类型：

![CMake 的生成菜单](https://resources.jetbrains.com/help/img/idea/2026.3/cl_cmake_generatemenu.png)

2. 选择要添加到新目标的文件：

![选择目标文件](https://resources.jetbrains.com/help/img/idea/2026.3/cl_cmake_generate_choosefiles.png)

3. CLion 将添加一个  `add_executable`  或  `add_library`  命令：

![通过生成菜单添加库目标的结果](https://resources.jetbrains.com/help/img/idea/2026.3/cl_cmake_generate_lib_result.png)

### CMake 的实时模板

使用 [实时模板](using-live-templates.html)快速插入结构或命令。 例如，键入  `exe`  并按 `Tab` (Windows), `⇥` (macOS), `⇥` (IntelliJ IDEA Classic (macOS)), `⇥` (macOS System Shortcuts), `Tab` (XWin), `Tab` (GNOME), `Tab` (KDE), `Tab` (Emacs), `Tab` (Sublime Text), `⇥` (Sublime Text (macOS)), `⇥` (Xcode), `Tab` (Visual Studio), `⇥` (Visual Studio (macOS)), `Tab` (ReSharper), `⇥` (ReSharper (macOS)), `Tab` (QtCreator), `⇥` (QtCreator (macOS)), `Tab` (NetBeans), `Tab` (Eclipse), `⇥` (Eclipse (macOS)) 以添加可执行文件目标：

![用于 add_executable 的 CMake 实时模板](https://resources.jetbrains.com/help/img/idea/2026.3/cl_livetemplates_cmake_exe.png)

![已插入 add_executable 模板](https://resources.jetbrains.com/help/img/idea/2026.3/cl_livetemplates_cmake_exe_result.png)

在  `设置 | 编辑器 | 实时模板 | CMake`  中查找 CMake 实时模板的完整列表。

### 参数信息弹窗

参数信息弹窗会在您键入时显示 CMake 命令的签名变体：

![CMake 的参数信息](https://resources.jetbrains.com/help/img/idea/2026.3/cl_cmake_paraminfo.png)

默认情况下，弹出窗口会在键入左中括号后 1 秒（1000 毫秒）内出现。 您可以在 [参数信息设置](viewing-method-parameter-information.html#configure-parameter-info-popup)中更改此设置。

要手动调用参数信息，请按 `Ctrl+P` (Windows), `⌘ P` (macOS), `⌘ P` (IntelliJ IDEA Classic (macOS)), `⌘ P` (macOS System Shortcuts), `Ctrl+P` (XWin), `Ctrl+P` (GNOME), `Ctrl+P` (KDE), `Alt+Shift+P` (Emacs), `Ctrl+P` (Sublime Text), `Ctrl+P` (Sublime Text (macOS)), `⌘ ⇧ P` (Xcode), `Ctrl+Shift+Space` (Visual Studio), `⌘ P` (Visual Studio (macOS)), `Ctrl+P` (ReSharper), `⌘ P` (ReSharper (macOS)), `Ctrl+P` (QtCreator), `Ctrl+P` (QtCreator (macOS)), `Ctrl+P` (NetBeans), `Ctrl+P` (Eclipse), `⌃ ⇧ Space` (Eclipse (macOS))。

### 快速文档弹窗

[快速文档弹窗](viewing-inline-documentation.html)帮助您获取有关 CMake 代码中元素的更多信息。 要调用它，请使用鼠标悬停或按 `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))。

例如，您可以查看补全建议的快速文档：

![CMake 补全中的快速文档](https://resources.jetbrains.com/help/img/idea/2026.3/cl_cmake_quickdoc_completion.png)

### 代码折叠

CMake 脚本中的折叠/展开功能适用于宏和函数、if-else 子句、代码块、注释以及任意代码选择（确保在  `设置 | 编辑器 | 常规 | 代码折叠`  中启用   自定义折叠区域   以使其生效）。

![CMake 代码折叠](https://resources.jetbrains.com/help/img/idea/2026.3/cl_cmake_folding.png)

> **Tip:**
> 按 `Ctrl+NumPad -` (Windows), `⌘ NumPad -` (macOS), `⌘ NumPad -` (IntelliJ IDEA Classic (macOS)), `⌘ NumPad -` (macOS System Shortcuts), `Ctrl+NumPad -` (XWin), `Ctrl+NumPad -` (GNOME), `Ctrl+NumPad -` (KDE), `Ctrl+NumPad -` (Emacs), `Ctrl+Shift+[` (Sublime Text), `⌘ ⌥ [` (Sublime Text (macOS)), `⌘ ⌥ ←` (Xcode), `Ctrl+M, S` (Visual Studio), `⌃ M, S` (Visual Studio (macOS)), `Ctrl+M, S` (ReSharper), `⌃ M, S` (ReSharper (macOS)), `Ctrl+Shift+Comma` (QtCreator), `⌘ ⇧ Comma` (QtCreator (macOS)), `Ctrl+NumPad -` (NetBeans), `Ctrl+NumPad -` (Eclipse), `⌘ NumPad -` (Eclipse (macOS))/ `Ctrl+NumPad +` (Windows), `⌘ NumPad +` (macOS), `⌘ NumPad +` (IntelliJ IDEA Classic (macOS)), `⌘ NumPad +` (macOS System Shortcuts), `Ctrl+NumPad +` (XWin), `Ctrl+NumPad +` (GNOME), `Ctrl+NumPad +` (KDE), `Ctrl+NumPad +` (Emacs), `Ctrl+Shift+]` (Sublime Text), `⌘ ⌥ ]` (Sublime Text (macOS)), `⌘ ⌥ →` (Xcode), `Ctrl+M, E` (Visual Studio), `⌃ M, E` (Visual Studio (macOS)), `Ctrl+M, E` (ReSharper), `⌃ M, E` (ReSharper (macOS)), `Ctrl+Shift+.` (QtCreator), `⌘ ⇧ .` (QtCreator (macOS)), `Ctrl+NumPad +` (NetBeans), `Ctrl+NumPad +` (Eclipse), `⌘ NumPad +` (Eclipse (macOS)) 以折叠或展开代码片段。

### 结构视图

[结构](file-structure.html)视图用于显示 CMake 脚本中使用的变量、函数、宏和目标。 要打开它，请按 `Alt+7` (Windows), `⌘ 7` (macOS), `⌘ 7` (IntelliJ IDEA Classic (macOS)), `⌘ 7` (macOS System Shortcuts), `Alt+7` (XWin), `Alt+7` (GNOME), `Alt+7` (KDE), `Alt+7` (Emacs), `Alt+7` (Sublime Text), `⌘ 7` (Sublime Text (macOS)), `⌘ 3` (Xcode), `Ctrl+Alt+F` (Visual Studio), `⌃ ⌥ F` (Visual Studio (macOS)), `Ctrl+F11` (ReSharper), `⌃ F11` (ReSharper (macOS)), `Alt+7` (QtCreator), `⌘ 7` (QtCreator (macOS)), `Ctrl+7` (NetBeans), `Alt+7` (Eclipse), `⌘ 7` (Eclipse (macOS))（工具窗口）或 `Ctrl+F12` (Windows), `⌘ F12` (macOS), `⌘ F12` (IntelliJ IDEA Classic (macOS)), `⌘ ⇧ 7` (macOS System Shortcuts), `Ctrl+F12` (XWin), `Ctrl+F12` (GNOME), `Ctrl+0` (KDE), `Ctrl+F12` (Emacs), `Ctrl+R` (Sublime Text), `⌘ R` (Sublime Text (macOS)), `⌃ 6` (Xcode), `Alt+\` (Visual Studio), `⌥ \` (Visual Studio (macOS)), `Ctrl+F12` (ReSharper), `⌘ F12` (ReSharper (macOS)), `Ctrl+F12` (QtCreator), `⌘ F12` (QtCreator (macOS)), `Ctrl+F12` (NetBeans), `Ctrl+F3` (Eclipse), `⌘ O` (Eclipse (macOS))（弹出窗口）。

![CMake 的结构视图](https://resources.jetbrains.com/help/img/idea/2026.3/cl_cmake_structureview.png)

### 可自定义的语法高亮

您可以在  `设置 | 编辑器 | 配色方案 | CMake`  中调整 CMake 文件的配色和字体方案：

![CMake 的配色方案设置](https://resources.jetbrains.com/help/img/idea/2026.3/cl_cmake_codestyle_settings.png)

## CMake 文件的代码样式

在  `设置 | 编辑器 | 代码样式 | CMake`  中，您可以调整应用于 CMake 文件的代码样式。 当您更改某个设置时，预览窗格会显示这将如何影响您的代码。

![CMake 代码样式设置](https://resources.jetbrains.com/help/img/idea/2026.3/cl_cmake_codestyle_settings_format.png)

> **Tip:**
> 有关 CLion 中代码样式选项的一般信息，请参阅 [代码样式](settings-code-style.html)。

## See also

### 参考

[CMake Tool Window](cmake.html) [CMake Settings](cmake0.html)

### 外部链接

[CMake Official Page](http://www.cmake.org/)

### 流程

[快速 CMake 教程](quick-cmake-tutorial.html) [Load/Reload CMake](reloading-project.html) [CMake 性能分析](cmake-profiling.html) [Working with source code](working-with-source-code.html)

