CMake示例项目教程

CMake示例项目教程

cmake-exampleExample project which demonstrates various CMake features.项目地址:https://gitcode.com/gh_mirrors/cm/cmake-example

1. 项目的目录结构及介绍

cmake-example/
├── CMakeLists.txt
├── README.md
├── src/
│   ├── main.cpp
│   ├── config.h.in
│   └── utils/
│       ├── utils.h
│       └── utils.cpp
└── tests/
    └── test_main.cpp

• CMakeLists.txt: 项目的根目录下的CMake配置文件。
• README.md: 项目的说明文档。
• src/: 源代码目录。
  • main.cpp: 项目的主启动文件。
  • config.h.in: 配置文件模板。
  • utils/: 工具类和函数的源代码目录。
    • utils.h: 工具类的头文件。
    • utils.cpp: 工具类的实现文件。
• tests/: 测试代码目录。
  • test_main.cpp: 测试主文件。

2. 项目的启动文件介绍

src/main.cpp 是项目的启动文件，负责初始化项目并调用其他模块的功能。以下是 main.cpp 的基本结构：

#include <iostream>
#include "config.h"
#include "utils/utils.h"

int main() {
    std::cout << "项目版本: " << PROJECT_VERSION << std::endl;
    utils::printHello();
    return 0;
}

• #include <iostream>: 引入标准输入输出流库。
• #include "config.h": 引入配置头文件。
• #include "utils/utils.h": 引入工具类头文件。
• main(): 主函数，程序的入口点。

3. 项目的配置文件介绍

CMakeLists.txt 是项目的配置文件，定义了项目的构建规则和依赖关系。以下是 CMakeLists.txt 的基本结构：

cmake_minimum_required(VERSION 3.10)
project(CMakeExample VERSION 1.0 LANGUAGES CXX)

# 设置C++标准
set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_STANDARD_REQUIRED ON)

# 配置头文件
configure_file(src/config.h.in src/config.h)

# 添加可执行文件
add_executable(cmake_example src/main.cpp src/utils/utils.cpp)

# 添加测试
enable_testing()
add_test(NAME test_utils COMMAND cmake_example_test tests/test_main.cpp)

• cmake_minimum_required(VERSION 3.10): 设置CMake的最低版本要求。
• project(CMakeExample VERSION 1.0 LANGUAGES CXX): 定义项目名称和版本。
• set(CMAKE_CXX_STANDARD 11): 设置C++标准为C++11。
• configure_file(src/config.h.in src/config.h): 配置头文件。
• add_executable(cmake_example src/main.cpp src/utils/utils.cpp): 添加可执行文件。
• enable_testing(): 启用测试。
• add_test(NAME test_utils COMMAND cmake_example_test tests/test_main.cpp): 添加测试。

以上是基于开源项目 https://github.com/bast/cmake-example.git 生成的教程，包含了项目的目录结构、启动文件和配置文件的介绍。

cmake-exampleExample project which demonstrates various CMake features.项目地址:https://gitcode.com/gh_mirrors/cm/cmake-example