【c++】自定义头文件与CMakeLists.txt添加

头文件建立与使用

• 源文件
• add.cpp

#include "add.h"             
#include "iostream"             

int add(int x, int y) {             
    std::cout << "hello";             
    return x + y;             
}

• 头文件
• add.h

1. 要注意的是在头文件中使用防卫式声明 即在头文件里只做声明，不做定义，以避免在多头文件连环引用时出现重复定义

2. #ifndef表示demo1目录下的add.h如果没有定义过，说明这是第一次引入该头文件，就执行下面内容，遇到#endif停止，而#define表示开始定义add.h。如果该头文件之后又被包含了那么#ifndef会避免反复执行

3. 大型项目中由于存在头文件冲突的可能（directoryA\config.h 和 directoryB\config.h）所以最好这样：

   DEMO1_ADD_H 即 目录名_头文件名_H

4. 头文件和其对应的源文件应该具有相同的文件名

// 头文件.h 头文件会为对应的源文件提供前向声明
#ifndef DEMO1_ADD_H
#define DEMO1_ADD_H
int add(int x, int y);

#endif //DEMO1_ADD_H

• 主函数
• main.cpp
• include引用时 尖括号 vs 双引号
• 当使用尖括号的时候，其实是在告诉预处理器对应的头文件并不是我们编写的。
• 当使用双引号的时候，其实是在告诉预处理器头文件是我们自己编写的。

#include <iostream>
#include "add.h"    // 这里使用“”而非<>

int main() {
    int rs = add(3, 4);
    std::cout << rs;
    return 0;
}

CMakeLists.txt的编写

• CMakeLists.txt 是一个配置文件，描述了如何使用 CMake 构建项目。
• 定义了项目的属性、源码文件、依赖关系以及生成目标
• 基本结构

# 必需的 CMake 最低版本  
cmake_minimum_required(VERSION <版本号>)  

# 项目信息  
project(<项目名称> [LANGUAGES CXX C])  

# 编译选项（如设置 C++ 标准）  
set(CMAKE_CXX_STANDARD 20)  
set(CMAKE_CXX_STANDARD_REQUIRED ON)  

# 添加源文件并定义目标  
add_executable(<目标名称> <源文件1> <源文件2>)  

# 添加链接库  
target_link_libraries(<目标名称> <库1> <库2>)  

# 自定义构建路径（可选）  
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)

编写完头文件后将项目添加进CMakeLists.txt要注意

• 头文件 不需要 明确列在 add_executable
• 因为它们不会直接被编译，而是通过被 .cpp 文件 #include 来间接参与编译

add_executable(main test/main.cpp test/add.cpp)

• add_executable是 CMake 的一个核心命令，用于定义一个可执行目标。

• 即：add_executable(<目标名> [源文件1] [源文件2] …)

• [源文件x] 这些文件会被一起编译并链接成一个单独的可执行文件 目标名.exe 因此目标名不可以重复

• 文件路径可以是 绝对路径 或 相对路径。相对路径是相对于当前 CMakeLists.txt 文件所在的目录。

CMakdeLists.txt的多目录管理

• 如果文件分布在多个子目录中，可以用 add_subdirectory 来管理模块化项目

project/      
├── CMakeLists.txt      
├── src/      
│   ├── main.cpp      
│   ├── add.cpp      
│   └── CMakeLists.txt      
└── include/      
    └── add.h      

可以在src/CMakeLists.txt：

add_executable(main main.cpp add.cpp)  

主目录 CMakeLists.txt：

cmake_minimum_required(VERSION 3.20)         
project(MyProject)         

add_subdirectory(src)         

如果想要更多了解CMakeList文件编写，则需要深入了解CMake。

• CMake 通过使用简单的配置文件 CMakeLists.txt，自动生成不同平台的构建文件
• 类似于DockerFile
  菜鸟cmake

文章参考LearnCpp中文版