寻找可拆分多参数函数声明的Clang Format配置方案

需求概述 #

我需要一套Clang配置，能把下面的代码A转换成代码B的格式。核心要求是：含3个及以上参数的函数声明/定义，要将左括号单独换行，每个参数各占一行，右括号也单独换行；同时所有大括号采用Allman风格（每个大括号单独占一行）。

代码A（输入） #

class X {
public:
    int function(Arg arg1, Arg arg2);

private:
    int _biggerFunction(Arg1 arg1, Arg2 arg2, bool arg3);
};

int X::function(Arg1 arg1, Arg2 arg2) {
    return arg1 + arg2;
}

int X::_biggerFunction(Arg1 arg1, Arg2 arg2, bool arg3) {
    if (arg3) {
        return arg1 + arg2;
    }
    else {
        return arg1 - arg2;
    }
}

代码B（期望输出） #

class X
{
public:
    int function(Arg arg1, Arg arg2);

private:
    int _biggerFunction
    (
        Arg arg1,
        Arg arg2,
        bool arg3
    );
};

int X::function(Arg1 arg1, Arg2 arg2)
{
    return arg1 + arg2;
}

int X::_biggerFunction
(
    Arg1 arg1,
    Arg2 arg2,
    bool arg3
)
{
    if (arg3)
    {
        return arg1 + arg2;
    }
    else
    {
        return arg1 - arg2;
    }
}

已尝试的配置及问题 #

我用Visual Studio的Clang Power Tools风格检测器生成了如下配置：

# Format Style Options - Created with Clang Power Tools
---
BasedOnStyle: WebKit
BreakBeforeBraces: Allman
ColumnLimit: 50
ExperimentalAutoDetectBinPacking: true
...

但该配置的输出和目标格式不符，具体输出如下：

测试输出 #

class X
{
public:
    int function(Arg arg1, Arg arg2);

private:
    int _biggerFunction(
        Arg1 arg1, Arg2 arg2, bool arg3);
};

int X::function(Arg1 arg1, Arg2 arg2)
{
    return arg1 + arg2;
}

int X::_biggerFunction(
    Arg1 arg1, Arg2 arg2, bool arg3)
{
    if (arg3)
    {
        return arg1 + arg2;
    }
    else
    {
        return arg1 - arg2;
    }
}

问题在于：函数左括号没有单独换行，多个参数仍挤在同一行，不符合预期。

解决方案说明 #

Clang-Format的局限性与近似配置 #

Clang-Format目前没有直接支持按参数数量（≥3个）触发换行的选项，只能通过列宽或强制换行的方式近似实现。以下配置可以让参数每行一个，且左括号换行，但会对所有超过列宽的函数生效，无法精准区分参数数量：

---
BasedOnStyle: WebKit
BreakBeforeBraces: Allman
ColumnLimit: 0 # 关闭列宽限制，强制多行参数拆分
AlignAfterOpenBracket: BlockIndent # 参数对齐到括号缩进
BinPackParameters: false # 禁止参数打包在同一行
AllowAllParametersOfDeclarationOnNextLine: true
...

这个配置会让所有带参数的函数（哪怕只有2个参数）都拆分成每行一个参数，和需求里“仅3个及以上参数拆分”有差异。

满足精确需求的替代工具 #

如果必须严格按参数数量（≥3个）拆分，推荐使用Uncrustify，它提供了更细粒度的控制选项。以下是实现需求的Uncrustify配置示例：

# Uncrustify配置
nl_func_paren = force       # 函数左括号强制单独换行
func_params_split = 3       # 参数数量≥3时，每个参数单独一行
break_braces = allman       # Allman风格大括号
align_func_params = true    # 参数对齐

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