Sekyoro的博客小屋
·
完整的C++项目构建注意事项
💡
原文中文，约13300字，阅读约需32分钟。
📝
内容提要
使用cmake构建C++项目的经验总结，包括项目组织方式、文档生成、代码检查和格式化、测试、库管理、安装和包配置文件。
🎯
关键要点
- 使用cmake构建C++项目的经验总结，包括项目组织方式、文档生成、代码检查和格式化、测试、库管理、安装和包配置文件。
- 推荐在src目录中创建模块目录，include目录中创建对应的同名目录以包含头文件，源代码放在app目录中。
- cmake支持模块化，使用add_subdirectory添加模块，便于管理和构建。
- 使用graphviz查看目标依赖，使用Doxygen生成文档，需按照规定格式撰写注释。
- Doxygen需要配置Doxyfile，CMake可以自动生成该文件以简化配置。
- 可以使用clang-tidy和clang-format进行代码检查和格式化，保持代码质量。
- CTest用于测试，需在顶层CMakeLists.txt中包含，支持多种测试标签和过滤功能。
- 使用FetchContent下载第三方库，支持vcpkg和Conan等包管理工具。
- 安装目标时，install(TARGETS ...)用于安装生成的目标，install(FILES ...)用于安装其他文件。
- 包配置文件Config.cmake用于方便其他用户使用find_package找到库。
❓
延伸问答
如何组织C++项目的目录结构？
推荐在src目录中创建模块目录，include目录中创建对应的同名目录以包含头文件，源代码放在app目录中。
如何使用CMake生成文档？
使用Doxygen生成文档，需要按照规定格式撰写注释，并配置Doxyfile，CMake可以自动生成该文件以简化配置。
CMake中如何进行代码检查和格式化？
可以使用clang-tidy和clang-format进行代码检查和格式化，以保持代码质量。
CTest在CMake中如何使用？
CTest用于测试，需在顶层CMakeLists.txt中包含，支持多种测试标签和过滤功能。
如何在CMake中管理第三方库？
可以使用FetchContent下载第三方库，支持vcpkg和Conan等包管理工具。
CMake中如何安装生成的目标？
使用install(TARGETS ...)用于安装生成的目标，install(FILES ...)用于安装其他文件。
➡️
