如何使 clang-format 尊重“类似表格”的代码格式

Question

我的代码中的数据表或参数表在列中对齐，如下所示（人为的简单示例；实际代码有更大的表）：

//        Name    Size    Starting val
//        ======= ======= ============
S s = {
        { "Dubs", abc,    123 },
        { "X",    n,      m   },
        { "YZ",   ij / q, kl  } 
    };

//           Name    Size    Starting val
//           ======= ======= ============
w  = Create( "Dubs", abc,    123 );
x  = Create( "X",    n,      m   );
yz = Create( "YZ",   ij / q, kl  );

clang-format 杀死表格格式：

//        Name    Size    Starting val
//        ======= ======= ============
S s = {
    { "Dubs", abc, 123 },
    { "X", n, m },
    { "YZ", ij / q, kl }
};

//           Name    Size    Starting val
//           ======= ======= ============
w  = Create( "Dubs", abc, 123 );
x  = Create( "X", n, m );
yz = Create( "YZ", ij / q, kl );

我们的团队希望采用 clang-format 并自动运行它，但这个问题阻止了我们这样做。我们可以手动检查所有这些情况并将所有这些情况包装在 // clang-format off/on 标记中，但这是体力劳动。

有没有办法设置 clang-format 来保持这样的表格，甚至自动表格化新代码？

Answer 1

您将无法让 clang-format 尊重所有自定义内部格式，并且他们的 documentation on adding new style options 非常严格。在现有代码库中采用 clang 格式需要一些 妥协。这是其中一种妥协。

我遇到了你的情况，一个庞大的代码库，有数十名工程师固定在他们的方式上，不愿意改变他们的内部编码标准。我已经进行了几个大型重构，这些重构需要数​​周的时间来修复间距。没有好好利用时间。

我无法驾驭传统格式标准化的政治。采用 Clang-Formats 的条件是尊重我们的传统格式。

我的解决方案是编写一个包装脚本，该脚本将读取文件，检测内部异常（在您的情况下，查找只有 '=' 和 ' ' 的长注释）并将它们夹在 clang 格式指令中：

// clang-format off
// AddedByYourTool
//           Name    Size    Starting val
//           ======= ======= ============
w  = Create( "Dubs", abc,    123 );
x  = Create( "X",    n,      m );
yz = Create( "YZ",   ij / q, kl );
// clang-format on

然后它将通过 clang-format 进行管道传输。然后在输出中找到 AdditionalByYourTool 并删除周围的 clang-format off。 （您需要该令牌，因此您不会删除现有的 clang-format offs）。

这很糟糕。这是一个可怕的解决方案，但除非你有权力下令终止这种格式，或者有政治技巧来谈判它，或者觉得在你的职业生涯中想要手动重新格式化，否则它是唯一真正的解决方案。

Answer 2

从 clang-format 13 开始，有一个新的 AlignArrayOfStructures 选项可用 这可以帮助解决这个问题。