如何在VSCode中正确格式化CMake输入头文件TutorialConfig.h.in？

你的问题根源在于.h.in是CMake专属的配置模板文件，它混合了C头文件语法和CMake特有的变量标记（@VAR@）、#cmakedefine指令，普通C++格式化工具不识别CMake语法，而CMake自带的格式化工具对C预处理器语法的支持有限，所以会出现警告或构建问题。以下是VSCode中的可行解决方法：

方法1：用Clang-Format适配CMake模板语法 #

Clang-Format是主流的C/C++格式化工具，通过自定义配置可以兼容CMake模板的特殊语法：

• 在项目根目录创建.clang-format文件，写入以下规则：

  Language: Cpp
  RawStringFormats:
    - Language: Cpp
      Delimiters:
        - '@'
      CanonicalDelimiter: '@'
      BasedOnStyle: google
  StatementMacros:
    - cmakedefine
  

  这个配置会把@VAR@视为原始字符串不拆分，同时将#cmakedefine识别为合法的预处理指令。
• 在VSCode中安装「C/C++」扩展，打开设置（Ctrl+,），搜索「C_Cpp: Formatting Provider」，选择「clang-format」作为默认格式化工具。
• 右键目标文件，选择「格式化文档」即可正常处理。

方法2：使用cmake-format专门处理 #

cmake-format是官方推荐的CMake文件格式化工具，对.h.in模板的支持更精准：

• 先通过pip安装：pip install cmake-format
• 在VSCode中安装「cmake-format」扩展（作者cheshirekow）。
• 在项目根目录创建.cmake-format.py配置文件，示例内容：

  cmake_format = {
      "line_width": 80,
      "indent_size": 2,
      "additional_command_kwargs": {
          "#define": {"indent": 0},
          "#cmakedefine": {"indent": 0},
      },
      "variable_case": "upper",
  }
  

• 关联文件类型：打开TutorialConfig.h.in，右下角点击「C Header」，选择「配置文件关联」，输入「CMake Template」，然后将该类型的默认格式化工具设为cmake-format。

方法3：应急禁用警告 #

如果只是临时消除警告，可采用以下方式：

• 针对C++工具的警告，在文件开头加// NOLINTBEGIN，结尾加// NOLINTEND，让静态检查工具跳过该文件。
• 确保CMake配置指令正确，在configure_file中加上@ONLY参数，避免CMake误处理非@VAR@格式的内容：

  configure_file(
      TutorialConfig.h.in
      TutorialConfig.h
      @ONLY
  )
  

内容的提问来源于stack exchange，提问作者Paisins