如何配置clang-format实现自定义Google风格的C++代码格式化

需求说明 #

需要基于Google风格格式化C++代码，同时满足以下自定义要求：

• 代码缩进为4个空格
• 列宽限制为80
• 函数参数采用常规缩进块格式
• 函数实参采用常规缩进块格式

期望的格式化效果示例：

SomeClass::SomeClass(
    OraQuery *p_query,
    ListView *p_list_view,
    bool p_fetch_all
) :
    m_query(p_query),
    m_list_view(p_list_view),
    m_fetch_all(p_fetch_all) {
    if (!m_fetch_all) {
        // ...
        someFunction(
            a1,
            a2,
            a3);
    }
    // ...
}

问题现状 #

尝试设置AlignAfterOpenBracket: BlockIndent未达到预期效果，当前配置如下：

{
    "BasedOnStyle": "Google",
    "IndentWidth": 4,
    "TabWidth": 4,
    "AlignAfterOpenBracket": "BlockIndent",
    "ColumnLimit": 80
}

解决方案 #

需要补充三个关键配置参数，调整后的完整配置如下：

{
    "BasedOnStyle": "Google",
    "IndentWidth": 4,
    "TabWidth": 4,
    "AlignAfterOpenBracket": "BlockIndent",
    "ColumnLimit": 80,
    "BinPackParameters": false,
    "BinPackArguments": false,
    "ConstructorInitializerIndentWidth": 4
}

参数说明 #

• BinPackParameters: false：禁用函数参数的打包换行，确保每个参数单独占一行并按块缩进，满足函数参数的格式要求
• BinPackArguments: false：禁用函数实参的打包换行，确保每个实参单独占一行并按块缩进，满足函数实参的格式要求
• ConstructorInitializerIndentWidth: 4：指定构造函数初始化列表的缩进宽度为4个空格，与函数参数的缩进保持一致，实现示例中的初始化列表格式

配置调整后，Clang-Format即可生成符合预期的代码格式。

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