dev-cmake 是一份针对 CMake 与 Make 构建系统的编写技能,定位为“像有数十年经验的首席工程师那样写构建文件”。它强调每一行都应有存在理由,简洁来自掌握而非走捷径。
用途:用于创建、重构、审查或调试 CMakeLists.txt 与 Makefile 等构建文件。
主要能力(CMake 部分):
- 核心哲学:target 即一切,现代 CMake 围绕 target 与属性而非变量与目录;显式优先于隐式,始终写明 PRIVATE、PUBLIC 或 INTERFACE;最小暴露面,默认 PRIVATE,仅在下游真正需要时用 PUBLIC。
- 项目结构建议:cmake_minimum_required(VERSION 3.16)、project 声明;在 target 层而非全局设置标准,使用编译特性而非编译标志。
- target 定义模式示例:add_library 配合命名空间 ALIAS,target_sources(含 FILE_SET HEADERS)、target_compile_features、带生成器表达式的 target_include_directories。
- 明确列出的反模式:include_directories()、link_directories()、add_definitions()、link_libraries()、直接改 CMAKE_CXX_FLAGS、用 file(GLOB) 收集源文件、在 target_link_libraries 中使用裸库名。
- 依赖处理:find_package 指定版本与组件并链接带命名空间的目标;优先用 FetchContent 而非 ExternalProject 引入 CMake 依赖。
- 生成器表达式:处理构建/安装路径差异(BUILD_INTERFACE / INSTALL_INTERFACE)与条件编译配置。
主要能力(Make 部分):
- 结构约定:用 ?= 定义可覆盖默认值,+= 追加;-MMD -MP 自动依赖跟踪;按目录组织中间产物与输出。
- 模式规则替代重复显式规则;自动变量 $@、$<、$^、$+、$* 的用途说明。
- 优雅写法要点:order-only 前置条件创建目录、-include 引入可选依赖文件、.PHONY 声明非文件目标、.DELETE_ON_ERROR 清理失败构建、一致的变量命名。
使用方式:在编写或审查构建文件时按其中的模式与检查清单执行;资料还提供三份参考文件——references/cmake-patterns.md(库导出、安装、presets、工具链等完整现代 CMake 模式)、references/make-patterns.md(多目录、交叉编译、依赖等高级 Make 模式)、references/antipatterns.md(常见错误及修复)。
质量检查清单:CMake 方面要求每个 target 有命名空间别名、所有 target_* 调用写明作用域、不使用目录级命令、构建/安装差异用生成器表达式、find_package 带版本要求、cmake_minimum_required 反映实际所用特性;Make 方面要求变量正确使用 ?= 或 +=、自动生成依赖、用模式规则、声明 .PHONY、clean 删除全部生成文件、构建产物与源码分离。
适用场景:C/C++ 项目的构建脚本编写、现代化改造、代码评审与构建问题排查。
限制:资料以构建实践指南与示例形式呈现,未说明其具体运行环境、安装方式或自动化程度;未提供收费、价格或平台信息。