如何阻止clang-format将函数参数逗号单独换行？

问题背景 #

我们维护一个多开发者协作的大型代码库，函数多行参数存在多种格式，需要避免clang-format生成以下两种不良格式：

格式1：参数后无逗号，下一行直接接参数 #

foo( arg1 /* comments here */
        arg2, // maybe even comments here
        arg3
    );

格式2：逗号换行后单独一行前置 #

foo( arg1 // comments here
        , arg2
        , arg3 // and here
    );

同时要避免clang-format将逗号单独置于新行（如补充示例中格式化后逗号独占一行的情况）。

原clang-format配置如下：

BasedOnStyle: Google  # Default to a style close to Astyle's "Java"
IndentWidth: 4        # Use 4 spaces for indentation
UseTab: Never         # Convert tabs to spaces
ColumnLimit: 0        # Disable line length limit (no line wrapping)

# Whitespace and Padding
SpacesInParentheses: false     # No spaces inside parentheses
SpaceAfterCStyleCast: false    # No space after C-style cast
SpaceAfterTemplateKeyword: false
SpaceBeforeParens: ControlStatements  # Space before parentheses in control statements (e.g., if, while)
# SpaceBeforeComma: false
# SpaceAfterComma: true          # Add padding after commas

# Pointer and Reference Alignment
PointerAlignment: Left        # Align pointer '*' with the type (similar to Astyle's --align-pointer=type)
ReferenceAlignment: Left      # Align reference '&' with the type (similar to Astyle's --align-reference=type)

# Indentation Rules
BreakBeforeBraces: Custom     # Control brace formatting specifically
BraceWrapping:
  AfterClass: false
  AfterControlStatement: true  # Attach braces to control statements
  AfterEnum: false
  AfterFunction: false
  AfterNamespace: false
  AfterStruct: false
  AfterUnion: false
  BeforeCatch: true
  BeforeElse: true
  IndentBraces: false         # Don't indent braces
  SplitEmptyFunction: true
  SplitEmptyRecord: true
  SplitEmptyNamespace: true

IndentCaseLabels: true             # Indent case labels in switch statements

# Preprocessor
IndentPPDirectives: BeforeHash      # Indent preprocessor directives, similar to --indent-preproc-define
SortIncludes: false

# One-liners
AllowShortBlocksOnASingleLine: true
AllowShortFunctionsOnASingleLine: Inline    # Keep short functions on a single line
AllowShortLoopsOnASingleLine: true          # Keep short loops on a single line
AllowShortIfStatementsOnASingleLine: true   # Keep short if statements on a single line
# AllowShortCompoundRequirementOnASingleLine: true
AllowShortLambdasOnASingleLine: true

# Miscellaneous
UseCRLF: true  # Use Windows line endings (CRLF)

# File-saving options
# ClangFormat doesn't have suffix or preserve date options

补充示例：

• 格式化前代码：

static void Spundwand_Knicken_Beulen(
    bool bEinzelBohleSpw  // Wenn Spundwand -> Einzelbohle? (nur Text wird geändert)
    ,    int nProfile  // Anzahl der Profile (z.B. 2x HEB 300)
    ,    bool bIsSpundwand  // sonst Werte je Profil/e (HEB...)
    ,    int mode_buckling  // 0: none 1: 1993-5 (sheet piles/soldier piles) 2: 1993-1-1 (walings, frames)
    ,    LPCTSTR section_name, double A_per_prof  // [cm2/lfm]
    ,    double E  // [MN/m2]
    ,    double Iy_per_prof  // [cm4/lfm]
    ,    std::vector<GF_EC3_SteelDimensioning::MNV>& mnv, double traegerabst, double W_el_per_prof  // [cm3/lfm]
    ,    double W_pl_per_prof  // [cm3/lfm]
    ,    double b  // [mm]
    ,    double beta  // [°]
    ,    double beta_B  // [-]
    ,    double beta_D  // [-]
    ,    double delta_s_rust  // [mm]
    ,    double f_yk  // [N/mm2]
    ,    double gamma_M0, double gamma_M1, double gamma_M2, double h  // [mm]
    ,    bool is_Z  // or U
    ,    int iHohlprofil  // 0:Z,I,H,U  1:Rechteckrohr  2:Kreisrohr
    ,    double s  // [mm]
    ,    double t  // [mm]
    ,    double r1  // [mm]
    ,    double bf  // [mm] Flange width
    ,    double Delta_hw  // [m] Water level difference
    // , int iOutLanguage // 0:en, 1:de
    ,    GFString& outstring, GFXMLTree* pResults, bool& bProofsTotalOK, bool want_table_output) {
...
}

• 格式化后（出现逗号独占一行的问题）：

static void Spundwand_Knicken_Beulen(
    bool bEinzelBohleSpw  // Wenn Spundwand -> Einzelbohle? (nur Text wird geändert)
    ,
    int nProfile  // Anzahl der Profile (z.B. 2x HEB 300)
    ,
    bool bIsSpundwand  // sonst Werte je Profil/e (HEB...)
    ,
    int mode_buckling  // 0: none 1: 1993-5 (sheet piles/soldier piles) 2: 1993-1-1 (walings, frames)
    ,
    LPCTSTR section_name, double A_per_prof  // [cm2/lfm]
    ,
    double E  // [MN/m2]
    ,
    double Iy_per_prof  // [cm4/lfm]
    ,
    std::vector<GF_EC3_SteelDimensioning::MNV>& mnv, double traegerabst, double W_el_per_prof  // [cm3/lfm]
    ,
    double W_pl_per_prof  // [cm3/lfm]
    ,
    double b  // [mm]
    ,
    double beta  // [°]
    ,
    double beta_B  // [-]
    ,
    double beta_D  // [-]
    ,
    double delta_s_rust  // [mm]
    ,
    double f_yk  // [N/mm2]
    ,
    double gamma_M0, double gamma_M1, double gamma_M2, double h  // [mm]
    ,
    bool is_Z  // or U
    ,
    int iHohlprofil  // 0:Z,I,H,U  1:Rechteckrohr  2:Kreisrohr
    ,
    double s  // [mm]
    ,
    double t  // [mm]
    ,
    double r1  // [mm]
    ,
    double bf  // [mm] Flange width
    ,
    double Delta_hw  // [m] Water level difference
    // , int iOutLanguage // 0:en, 1:de
    ,
    GFString& outstring, GFXMLTree* pResults, bool& bProofsTotalOK, bool want_table_output) {
...
}

解决方案 #

需要在原配置中添加/修改几个关键选项，确保逗号紧跟参数，不单独换行，同时规范参数格式：

修改后的完整配置 #

BasedOnStyle: Google  # Default to a style close to Astyle's "Java"
IndentWidth: 4        # Use 4 spaces for indentation
UseTab: Never         # Convert tabs to spaces
ColumnLimit: 0        # Disable line length limit (no line wrapping)

# Whitespace and Padding
SpacesInParentheses: false     # No spaces inside parentheses
SpaceAfterCStyleCast: false    # No space after C-style cast
SpaceAfterTemplateKeyword: false
SpaceBeforeParens: ControlStatements  # Space before parentheses in control statements (e.g., if, while)
SpaceBeforeComma: false        # 逗号前无空格，确保逗号紧跟参数
SpaceAfterComma: true          # 逗号后加空格，保持可读性
BreakBeforeComma: false        # 禁止将逗号放在新行开头（核心选项，解决逗号独占一行问题）

# Pointer and Reference Alignment
PointerAlignment: Left        # Align pointer '*' with the type (similar to Astyle's --align-pointer=type)
ReferenceAlignment: Left      # Align reference '&' with the type (similar to Astyle's --align-reference=type)

# Indentation Rules
BreakBeforeBraces: Custom     # Control brace formatting specifically
BraceWrapping:
  AfterClass: false
  AfterControlStatement: true  # Attach braces to control statements
  AfterEnum: false
  AfterFunction: false
  AfterNamespace: false
  AfterStruct: false
  AfterUnion: false
  BeforeCatch: true
  BeforeElse: true
  IndentBraces: false         # Don't indent braces
  SplitEmptyFunction: true
  SplitEmptyRecord: true
  SplitEmptyNamespace: true

IndentCaseLabels: true             # Indent case labels in switch statements

# Preprocessor
IndentPPDirectives: BeforeHash      # Indent preprocessor directives, similar to --indent-preproc-define
SortIncludes: false

# One-liners
AllowShortBlocksOnASingleLine: true
AllowShortFunctionsOnASingleLine: Inline    # Keep short functions on a single line
AllowShortLoopsOnASingleLine: true          # Keep short loops on a single line
AllowShortIfStatementsOnASingleLine: true   # Keep short if statements on a single line
# AllowShortCompoundRequirementOnASingleLine: true
AllowShortLambdasOnASingleLine: true

# Miscellaneous
UseCRLF: true  # Use Windows line endings (CRLF)

# 新增参数换行控制选项
AlignAfterOpenBracket: Align  # 多行参数对齐到括号后的位置，避免参数错位
BinPackArguments: false       # 禁止将多个参数打包到同一行（可选，根据团队需求调整）

关键选项说明 #

• BreakBeforeComma: false：核心选项，强制逗号紧跟在参数末尾，不会被单独放到新行。
• SpaceBeforeComma: false：确保参数和逗号之间无空格，保持格式紧凑。
• SpaceAfterComma: true：逗号后添加空格，保证参数间的可读性。
• AlignAfterOpenBracket: Align：让多行参数对齐到函数括号后的缩进位置，避免出现参数错位的不良格式。
• BinPackArguments: false：若团队希望每行仅保留一个参数则设为false；若允许同一行放多个关联参数，可设为true，根据实际需求调整。

应用上述配置后，函数参数会保持逗号紧跟参数、无单独换行的格式，同时避免两种不良排版。

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