如何让clang-format优先在注释中换行而非代码中换行？

一、针对宏定义的调整 #

要避免clang-format拆分宏定义、优先拆分注释，需要调整两个惩罚项：

• PenaltyBreakMacro：设为较高值（比如1000），大幅惩罚宏定义的换行行为，让工具尽量保持宏的单行结构。
• PenaltyBreakComment：设为较低值（比如10），降低注释换行的惩罚，让工具更愿意拆分长注释而非宏。

示例配置片段：

PenaltyBreakMacro: 1000
PenaltyBreakComment: 10

二、针对变量声明的调整 #

对于变量类型和名称被拆分的问题，需要增加类型与变量名之间换行的惩罚：

• PenaltyBreakDeclarator：设为较高值（比如500），让clang-format尽量避免在类型和变量名之间换行，优先拆分后续的长注释。

补充配置片段：

PenaltyBreakDeclarator: 500

三、完整示例配置 #

把这些项加入你的.clang-format文件：

BasedOnStyle: LLVM
ColumnLimit: 80  # 根据你的实际列宽限制调整
PenaltyBreakMacro: 1000
PenaltyBreakComment: 10
PenaltyBreakDeclarator: 500

四、预期效果 #

应用配置后，代码会优先拆分长注释，保持宏定义和变量声明的单行结构：

#define MY_FILE_EXTENSION "foo"  //!< file extension of all files that ...
                                 //!< very long comment
uint8_t _u8CurrentFileIdx;  //!< Very long comment, that exceeds
                            //!< the max column limit

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