Cpp-Boilerplate 项目教程

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

cpp-boilerplate/
├── CMakeLists.txt
├── README.md
├── include/
│   └── boilerplate/
│       └── example.h
├── src/
│   ├── main.cpp
│   └── example.cpp
└── tests/
    └── example_test.cpp

• CMakeLists.txt: 用于构建项目的CMake配置文件。
• README.md: 项目说明文档。
• include/: 包含项目的头文件。
  • boilerplate/: 具体的头文件目录。
    • example.h: 示例头文件。
• src/: 包含项目的源文件。
  • main.cpp: 项目的主入口文件。
  • example.cpp: 示例源文件。
• tests/: 包含项目的测试文件。
  • example_test.cpp: 示例测试文件。

2. 项目的启动文件介绍

src/main.cpp 是项目的启动文件，负责初始化和启动整个应用程序。以下是 main.cpp 的示例代码：

#include <iostream>
#include "boilerplate/example.h"

int main() {
    std::cout << "Hello, World!" << std::endl;
    example::say_hello();
    return 0;
}

• #include : 引入标准输入输出库。
• #include "boilerplate/example.h": 引入项目的头文件。
• int main(): 主函数，程序的入口点。
• std::cout << "Hello, World!" << std::endl;: 输出 "Hello, World!"。
• example::say_hello();: 调用示例函数 say_hello()。
• return 0;: 返回0，表示程序正常结束。

3. 项目的配置文件介绍

CMakeLists.txt 是项目的配置文件，用于配置和构建项目。以下是 CMakeLists.txt 的示例内容：

cmake_minimum_required(VERSION 3.10)
project(cpp-boilerplate)

set(CMAKE_CXX_STANDARD 17)

include_directories(include)

add_executable(cpp-boilerplate
    src/main.cpp
    src/example.cpp
)

enable_testing()

add_test(NAME example_test COMMAND example_test)

• cmake_minimum_required(VERSION 3.10): 指定所需的最低CMake版本。
• project(cpp-boilerplate): 定义项目名称。
• set(CMAKE_CXX_STANDARD 17): 设置C++标准为C++17。
• include_directories(include): 包含头文件目录。
• add_executable(cpp-boilerplate ...): 定义可执行文件及其源文件。
• enable_testing(): 启用测试。
• add_test(NAME example_test COMMAND example_test): 添加测试。