CMake 选项

option

用于为项目创建一个可选的配置变量。这些变量可以由用户在运行 CMake 配置阶段时设置为 ON 或 OFF，通常用于控制可选的功能或编译选项。

option(<variable> "help string" <initial value>)

# 将创建一个名为 USE_MY_FEATURE 的选项，其初始值为 ON，并提供一个帮助字符串说明这个选项的作用
option(USE_MY_FEATURE "Enable the my_feature functionality" ON)

# 在条件语句中使用选项
option(USE_MY_FEATURE "Enable the my_feature functionality" OFF)
add_library(my_library src.cpp)
if(USE_MY_FEATURE)
    target_compile_definitions(my_library PRIVATE USE_MY_FEATURE)
endif()

# 在 CMake GUI 中设置选项
cmake -DUSE_MY_FEATURE=ON ..

• <variable>：这是配置变量的名称，它将被设置为 ON 或 OFF。
• "help string"：这是显示给用户的描述性字符串，说明这个选项的用途。它通常用于 CMake GUI 或 ccmake/CMake GUI 中。
• <initial value>：这是变量的初始值。如果用户没有明确地设置这个变量，CMake 将使用这个值（可以是 ON 或 OFF）。