保留特定预处理器的缩进包括具有 clang 格式的块

Question

我们在包含外部库时包含保护某些定义的机制，我们希望在格式化代码时保持它们原样，最终按字母顺序排列块的内容。

例如：

#include <ExternalIncludeBegin.h>
#    include <somelib/someheader.h>
#    include <somelib/anotherheader.h>
#include <ExternalIncludeEnd.h>

现在，clang-format 将此块转换为

#include <ExternalIncludeBegin.h>
#include <somelib/someheader.h>
#include <somelib/anotherheader.h>
#include <ExternalIncludeEnd.h>

但是我想保留原始缩进，如果可能的话，不必用新代码封装所有内容（我们要格式化的代码库非常古老而且很大），clang-format 在这里可以为我做些什么吗？

Answer 1

看看“禁用格式”功能

Disabling Formatting on a Piece of Code
Clang-format understands also special comments that switch formatting in a delimited range. The code between a comment // clang-format off or /* clang-format off */ up to a comment // clang-format on or /* clang-format on */ will not be formatted. The comments themselves will be formatted (aligned) normally.

int formatted_code;
// clang-format off
    void    unformatted_code  ;
// clang-format on
void formatted_code_again;

更多详情：https://clang.llvm.org/docs/ClangFormatStyleOptions.html

因此，您也可以使用“sed”或其他工具在整个项目中注入特定于 clang 的 cmets。