如何使 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 取消表格格式：

//        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 来保留这样的表格，甚至自动表格化新代码？

您将无法让 clang-format 尊重所有自定义内部格式及其有关添加新样式选项的文档 https://clang.llvm.org/docs/ClangFormatStyleOptions.html#adding-additional-style-options相当紧。将 clang-format 采用到现有代码库中需要some妥协。这是这些妥协之一。

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

我无法驾驭标准化遗留格式的政治。 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 进行管道传输。然后在输出中找到AddedByYourTool并删除周围的clang-format。 （您需要该令牌，这样您就不会删除现有的 clang-format 关闭）。

太糟糕了。这是一个可怕的解决方案，但除非你有能力命令这种格式消失，或者有政治技巧来协商它的消失，或者想要在你的余下职业生涯中手动重新格式化，否则这是唯一真正的解决方案。