4188 字
21 分钟
页面浏览--访问次数--
C++ 代码格式化配置详解
2019-02-112026-10-16教程C++clang-format工具

代码格式化的意义#

很多人编写程序时不注意程序的版式结构，这样做虽然不会影响程序的功能，但是程序的可读性会大大降低。

C++ 语言的格式很自由，这意味着换行、空格、空行和制表符等空白在程序运行时都会被忽略，程序员可以使用空白让代码按照特定的风格缩进或分开，使程序更加清晰易懂。

个人认为，在 OI 考场上，一个优秀的码风可以有些提高你的调试效率。

假设我们写的是文章而不是程序，那么你一定觉得诸如文章应该分为若干个自然段、每段开头空两格之类的规则是理所当然的。如果段落的开头不空两格，或者干脆把整个文章写成单独的一段，仔细想来似乎也不会影响文章实质内容的表达。既然如此，我们为什么还要在形式上下功夫呢？设想一下，如果你手中的这本书既无章节也无目录，正文中的不同内容都使用同样的字体字号印刷，几百页纸从头至尾洋洋洒洒如念经般地“一气呵成”，你还有耐心看下去吗？

这是一个人人都能理解的道理，可是当文章变成程序的时候，就不是每个人都能想得通的了。不仅仅是初学者，甚至一些熟练的开发人员，也会写出凌乱不堪的代码。许多人一定有过这样的经历：一年半载之后，自己原来写的程序就完全看不懂了。如果这段程序只是为了交作业，或者临时一用，那还可以不去追究，但如果这是一个商业软件，现在需要根据客户的要求进行修改的话，工作量可就大了——你不得不先花时间把你原来的思路看懂。

肯定会有人反驳：代码是给机器运行的，又不是给人看的，写那么好看有什么用？

他的话只对了前半句：代码确实是给机器运行的，可是机器总共才需要看它几分钟？你花一个月编写的程序，机器顶多两三分钟就编译好了——在这两三分钟之前，这代码不都是你在看吗？开发软件编写代码不是一朝一夕的事情，更多的情况下，一个软件的开发要经历很长的时间，并且常常由多人合作完成。一个庞大的软件项目，可能会动用上千名程序员工作数年！如果把代码写得连自己都看不明白，怎么与别人交流？同一个开发团队内，一定要保持良好且一致的代码风格，才能最大化地提高开发效率。

代码格式化演示#

感谢 @xlj2596 提供的洛谷 P3371代码，评测记录：R16227912。

格式化前代码#

// luogu-judger-enable-o2
#include<cstdio>
#include<cstring>
#include<algorithm>
const int maxm=10005;
const int maxn=500005;
using namespace std;
bool vis[maxm];
int N,M,S,F,G,W,_start,_end,_size,Q[4000005],f[maxm],to[maxn<<1],val[maxn<<1],nxt[maxn<<1],las[maxn<<1];
inline void addedge(int x,int y,int z){_size++;to[_size]=y;val[_size]=z;nxt[_size]=las[x];las[x]=_size;}
inline void spfa(){
    _end=1;_start=1;f[S]=0;Q[1]=S;
    memset(f,63,sizeof(f));
    while(_start<=_end){
        int x=Q[_start++];
        vis[x]=false;//已经访问
        for(int i=las[x];i;i=nxt[i]){
            if(f[x]+val[i]<f[to[i]]){
                f[to[i]]=f[x]+val[i];
                if(!vis[to[i]]){
                    vis[to[i]]=true;
                    Q[++_end]=to[i];
                }
            }
        }
    }
}
int main(){
    scanf("%d%d%d",&N,&M,&S);
    for(int i=1;i<=M;i++){scanf("%d%d%d",&F,&G,&W);addedge(F,G,W);}
    spfa();
    for(int i=1;i<=N;i++){
        printf("%d%c",f[i]>1e9?2147483647:f[i],i==N?'\n':' ');
        //if(f[i]>1e9)printf("2147483647 ");
        //else printf("%d ",f[i]);
        //printf("%d ",f[i]>1e9?2147483647:f[i]);


    }
    return 0;
}

格式化后代码#

#include <algorithm>
#include <cstdio>
#include <cstring>
const int maxm = 10005;
const int maxn = 500005;
using namespace std;
bool vis[ maxm ];
int N, M, S, F, G, W, _start, _end, _size, Q[ 4000005 ], f[ maxm ],
    to[ maxn << 1 ], val[ maxn << 1 ], nxt[ maxn << 1 ], las[ maxn << 1 ];
inline void addedge( int x, int y, int z ) {
    _size++;
    to[ _size ] = y;
    val[ _size ] = z;
    nxt[ _size ] = las[ x ];
    las[ x ] = _size;
}
inline void spfa() {
    _end = 1;
    _start = 1;
    f[ S ] = 0;
    Q[ 1 ] = S;
    memset( f, 63, sizeof( f ) );
    while ( _start <= _end ) {
        int x = Q[ _start++ ];
        vis[ x ] = false;  //已经访问
        for ( int i = las[ x ]; i; i = nxt[ i ] ) {
            if ( f[ x ] + val[ i ] < f[ to[ i ] ] ) {
                f[ to[ i ] ] = f[ x ] + val[ i ];
                if ( !vis[ to[ i ] ] ) {
                    vis[ to[ i ] ] = true;
                    Q[ ++_end ] = to[ i ];
                }
            }
        }
    }
}
int main() {
    scanf( "%d%d%d", &N, &M, &S );
    for ( int i = 1; i <= M; i++ ) {
        scanf( "%d%d%d", &F, &G, &W );
        addedge( F, G, W );
    }
    spfa();
    for ( int i = 1; i <= N; i++ ) {
        printf( "%d%c", f[ i ] > 1e9 ? 2147483647 : f[ i ],
                i == N ? '\n' : ' ' );
        // if(f[i]>1e9)printf("2147483647 ");
        // else printf("%d ",f[i]);
        // printf("%d ",f[i]>1e9?2147483647:f[i]);
    }
    return 0;
}

C++#

对于 C++，普遍使用 clang-format 来格式化代码，当然，你也可以选择 Visual Studio 自带的格式化功能。这里不介绍 Visual Studio 的安装，请自行查阅官方文档。

如何安装 clang-format#

Windows 玩家#

只下载 clang-format 程序#

建议直接下载 clang-format 可执行文件。官方发布页（LLVM Releases 或 GitHub Releases）提供各平台的独立压缩包，解压后即可使用。

你可以使用命令行来调用程序，详见 ClangFormat 官方文档。

下载 Clang 提供完整体验#

clang-format 程序作为 Clang 的一部分，你可以选择下载整个包以获得完整体验。

VSCode 玩家#

在扩展（插件）页面安装 C/C++ 扩展（ms-vscode.cpptools，旧称 cpptools），你就可以对选中代码块使用 Ctrl+K Ctrl+F 来格式化代码，或者用 Shift+Alt+F 格式化整个文件。

Ubuntu 玩家#

Terminal window
sudo apt install clang-format

RHEL 系发行版玩家（CentOS / Rocky Linux / AlmaLinux）#

Terminal window
sudo dnf install clang-tools-extra

配置你的代码风格#

本实验基于 Windows 10 x64 1809 专业版 & VSCode 1.31.0（2019 年写作时的环境，操作方式在后来的版本中基本一致）。

基于上述方法安装后，你可以打开一个文件夹，如下图所示。

在 VSCode 中打开一个文件夹

新建一个文件，叫做 .clang-format 或者 _clang-format。

然后打开这个文件，就像这样。

用 VSCode 打开 .clang-format 配置文件

输入你的配置文件，保存并关闭。

这样你就可以使用代码格式化了：选中你要格式化的部分并按下 Ctrl+K Ctrl+F 格式化选区，或者按下 Shift+Alt+F 格式化全文。

配置文件的书写#

模板#

配置文件
---
# 语言: None, Cpp, Java, JavaScript, ObjC, Proto, TableGen, TextProto
Language:  Cpp
# BasedOnStyle:  LLVM
# 访问说明符(public、private等)的偏移
AccessModifierOffset:  -4
# 开括号(开圆括号、开尖括号、开方括号)后的对齐
# clang-format 22 起该选项改为布尔值：Align→true、DontAlign→false，
# AlwaysBreak 由 BreakAfterOpenBracket* 等新选项取代
AlignAfterOpenBracket:  true
# 连续赋值时，对齐所有等号
AlignConsecutiveAssignments:  true
# 连续声明时，对齐所有声明的变量名
AlignConsecutiveDeclarations:  false
# 左对齐逃脱换行(使用反斜杠换行)的反斜杠: DontAlign, Left, LeftWithLastLine, Right
# 旧版写作 AlignEscapedNewlinesLeft: true，该写法已被移除
AlignEscapedNewlines:  Left
# 水平对齐二元和三元表达式的操作数: DontAlign, Align, AlignAfterOperator
AlignOperands:  Align
# 对齐连续的尾随的注释
AlignTrailingComments:  true
# 允许函数声明的所有参数在放在下一行
AllowAllParametersOfDeclarationOnNextLine:  true
# 允许短的块放在同一行: Never, Empty, Always
AllowShortBlocksOnASingleLine:  Never
# 允许短的case标签放在同一行
AllowShortCaseLabelsOnASingleLine:  false
# 允许短的函数放在同一行: None, InlineOnly(定义在类中), Empty(空函数), Inline(定义在类中，空函数), All
AllowShortFunctionsOnASingleLine:  Empty
# 允许短的if语句保持在同一行: Never, WithoutElse, OnlyFirstIf, AllIfsAndElse
AllowShortIfStatementsOnASingleLine:  Never
# 允许短的循环保持在同一行
AllowShortLoopsOnASingleLine:  false
# 总是在返回类型后换行: None, All, TopLevel(顶级函数，不包括在类中的函数),
#   AllDefinitions(所有的定义，不包括声明), TopLevelDefinitions(所有的顶级函数的定义)
# 旧版写作 AlwaysBreakAfterReturnType / AlwaysBreakAfterDefinitionReturnType，两者均已废弃
BreakAfterReturnType:  None
# 总是在多行string字面量前换行
AlwaysBreakBeforeMultilineStrings:  false
# 总是在template声明后换行: Leave, No, MultiLine, Yes
# 旧版写作 AlwaysBreakTemplateDeclarations: false，已废弃
BreakTemplateDeclarations:  No
# false表示函数实参要么都在同一行，要么都各自一行
BinPackArguments:  true
# false表示所有形参要么都在同一行，要么都各自一行
BinPackParameters:  true
# 在大括号前换行: Attach(始终将大括号附加到周围的上下文), Linux(除函数、命名空间和类定义，与Attach类似),
#   Mozilla(除枚举、函数、记录定义，与Attach类似), Stroustrup(除函数定义、catch、else，与Attach类似),
#   Allman(总是在大括号前换行), GNU(总是在大括号前换行，并对于控制语句的大括号增加额外的缩进), WebKit(在函数前换行), Custom
#   注：这里认为语句块也属于函数
BreakBeforeBraces:  Custom
# 大括号换行，只有当BreakBeforeBraces设置为Custom时才有效
BraceWrapping:
    # class定义后面
    AfterClass:  false
    # 控制语句后面: Never, MultiLine, Always（旧版为布尔值 false，已废弃）
    AfterControlStatement:  Never
    # enum定义后面
    AfterEnum:  false
    # 函数定义后面
    AfterFunction:  false
    # 命名空间定义后面
    AfterNamespace:  false
    # ObjC定义后面
    AfterObjCDeclaration:  false
    # struct定义后面
    AfterStruct:  false
    # union定义后面
    AfterUnion:  false
    # catch之前
    BeforeCatch:  false
    # else之前
    BeforeElse:  true
    # 缩进大括号
    IndentBraces:  false
# 在二元运算符前换行: None(在操作符后换行), NonAssignment(在非赋值的操作符前换行), All(在操作符前换行)
BreakBeforeBinaryOperators:  NonAssignment
# 在三元运算符前换行
BreakBeforeTernaryOperators:  true
# 在构造函数的初始化列表的逗号前换行
# 旧版写作 BreakConstructorInitializersBeforeComma: false，已废弃，对应 BeforeColon
BreakConstructorInitializers:  BeforeColon
# 每行字符的限制，0表示没有限制
ColumnLimit:  80
# 描述具有特殊意义的注释的正则表达式，它不应该被分割为多行或以其它方式改变
CommentPragmas:  '^ IWYU pragma:'
# 构造函数的初始化列表的打包方式: Never, BinPack, CurrentLine, NextLine
# 旧版写作 ConstructorInitializerAllOnOneLineOrOnePerLine: false，已废弃，对应 BinPack
PackConstructorInitializers:  BinPack
# 构造函数的初始化列表的缩进宽度
ConstructorInitializerIndentWidth:  4
# 延续的行的缩进宽度
ContinuationIndentWidth:  4
# 去除C++11的列表初始化的大括号{后和}前的空格: Block, FunctionCall
Cpp11BracedListStyle:  Block
# 继承最常用的指针和引用的对齐方式
DerivePointerAlignment:  false
# 关闭格式化
DisableFormat:  false
# 自动检测函数的调用和定义是否被格式为每行一个参数(Experimental)
ExperimentalAutoDetectBinPacking:  false
# 需要被解读为foreach循环而不是函数调用的宏
ForEachMacros:  [ foreach, Q_FOREACH, BOOST_FOREACH ]
# 对#include进行排序，匹配了某正则表达式的#include拥有对应的优先级，匹配不到的则默认优先级为INT_MAX(优先级越小排序越靠前)，
#   可以定义负数优先级从而保证某些#include永远在最前面
IncludeCategories:
  - Regex:  '^"(llvm|llvm-c|clang|clang-c)/'
    Priority:  2
  - Regex:  '^(<|"(gtest|isl|json)/)'
    Priority:  3
  - Regex:  '.*'
    Priority:  1
# 缩进case标签
IndentCaseLabels:  false
# 缩进宽度
IndentWidth:  4
# 函数返回类型换行时，缩进函数声明或函数定义的函数名
IndentWrappedFunctionNames:  false
# 保留在块开始处的空行（新版改用 KeepEmptyLines.AtStartOfBlock，本项已废弃）
KeepEmptyLinesAtTheStartOfBlocks:  true
# 开始一个块的宏的正则表达式
MacroBlockBegin:  ''
# 结束一个块的宏的正则表达式
MacroBlockEnd:  ''
# 连续空行的最大数量
MaxEmptyLinesToKeep:  1
# 命名空间的缩进: None, Inner(缩进嵌套的命名空间中的内容), All
NamespaceIndentation:  Inner
# 使用ObjC块时缩进宽度
ObjCBlockIndentWidth:  4
# 在ObjC的@property后添加一个空格
ObjCSpaceAfterProperty:  false
# 在ObjC的protocol列表前添加一个空格
ObjCSpaceBeforeProtocolList:  true
# 在call(后对函数调用换行的penalty
PenaltyBreakBeforeFirstCallParameter:  19
# 在一个注释中引入换行的penalty
PenaltyBreakComment:  300
# 第一次在<<前换行的penalty
PenaltyBreakFirstLessLess:  120
# 在一个字符串字面量中引入换行的penalty
PenaltyBreakString:  1000
# 对于每个在行字符数限制之外的字符的penalty
PenaltyExcessCharacter:  80
# 将函数的返回类型放到它自己的行的penalty
PenaltyReturnTypeOnItsOwnLine:  80
# 指针和引用的对齐: Left, Right, Middle
PointerAlignment:  Left
# 允许重新排版注释
ReflowComments:  true
# 允许排序#include
SortIncludes:  true
# 在C风格类型转换后添加空格
SpaceAfterCStyleCast:  false
# 在赋值运算符之前添加空格
SpaceBeforeAssignmentOperators:  true
# 开圆括号之前添加一个空格: Never, ControlStatements, ControlStatementsExceptControlMacros, NonEmptyParentheses, Always
SpaceBeforeParens:  ControlStatements
# 在空的圆括号中添加空格
SpaceInEmptyParentheses:  false
# 在尾随的评论前添加的空格数(只适用于//)
SpacesBeforeTrailingComments:  2
# 在尖括号的<后和>前添加空格: Never, Always, Leave
SpacesInAngles:  Always
# 在容器(ObjC和JavaScript的数组和字典等)字面量中添加空格
SpacesInContainerLiterals:  true
# 在C风格类型转换的括号中添加空格（新版改用 SpacesInParens.InCStyleCasts，本项已废弃）
SpacesInCStyleCastParentheses:  true
# 在圆括号的(后和)前添加空格
SpacesInParentheses:  true
# 在方括号的[后和]前添加空格，lamda表达式和未指明大小的数组的声明不受影响
SpacesInSquareBrackets:  true
# 标准: Cpp03, Cpp11, Cpp14, Cpp17, Cpp20, Cpp23, Latest, Auto
Standard:  Cpp11
# tab宽度
TabWidth:  4
# 使用tab字符: Never, ForIndentation, ForContinuationAndIndentation, Always
UseTab:  Never

语法#

配置文件使用 YAML 语法，大抵概括如下：

  • 所有的注释以 # 开头。
  • 所有的值以 Key: Value 形式出现，每行一个，冒号是英文冒号，冒号后面空一格或者一个 Tab。
  • 同一个配置文件里不能出现重复的键（后出现的会覆盖先出现的，容易埋坑）。

参数解释#

这里只解释一些容易出现错误或者混淆的参数，其余参数，请参见 Clang 格式样式选项或阅读附图上的谷歌翻译后的文档。如果阅读后还有异议，请在下方评论，博主会酌情回答和解释。

易出现错误或者混淆的参数#

  • Language：字符串，取值范围。该配置文件针对的语言。请填写 Cpp，不是 cpp、cpp11、C++、kkkAKIOI 等。

  • BasedOnStyle：字符串，取值范围。基于的语言。点击链接可以查看内容和效果。当你没有配置值的时候，参考你所选择的标准。

  • AccessModifierOffset：整型。（public、private 等）访问说明符的偏移，如下图。一般用不到。

  • AlignAfterOpenBracket：开括号（开圆括号、开尖括号、开方括号）后的对齐方式。

    • 旧版取值为 Align（对齐到开括号后的参数）、DontAlign（不做对齐）、AlwaysBreak（参数不适合单行时在开括号后换行）。

    • clang-format 22 起该选项改为布尔值：Align 等价于 true，DontAlign 等价于 false；AlwaysBreak 的行为改由 BreakAfterOpenBracketFunction、BreakAfterOpenBracketBracedList、BreakAfterOpenBracketIf 等新选项控制，闭合括号一侧对应 BreakBeforeCloseBracket*。

    • Align（旧版，现为 true）：对齐打开括号上的参数

      e.g.

      someLongFunction(argument1,
                       argument2);

    • DontAlign（旧版，现为 false）：不用对齐

      e.g.

      someLongFunction(argument1,
        argument2);

    • AlwaysBreak：如果参数不适合单行，则在开括号后断开

      e.g.

      someLongFunction(
        argument1, argument2);

  • AlignConsecutiveAssignments：布尔值。对齐连续分配。如果取值为真，对齐连续行的赋值运算符。

    e.g.

    int kkk  = 666;
    int cz   = 888;
    int c    = 999;

  • AlignConsecutiveDeclarations：布尔值。如果取值为真，对齐连续行的声明名称。

    e.g.

    int         aaaa = 12;
    float       b = 23;
    std::string ccc = 23;

Clang 格式样式选项全文档#

Clang 格式样式选项全文档（长图）

图的尺寸 1903×31205，约 2.5 MB，强烈建议直接右键另存为下来慢慢看。

C++ 代码格式化配置详解
https://www.ariels.xyz/posts/clang-format-configuration/
作者
Ariel
发布于
2019-02-11
许可协议
CC BY-NC-ND 4.0

分享文章

生成精美分享图或复制链接，与更多人分享本文。

继续阅读

换条路线

从其他文章中稳定抽取

评论

正在加载评论...
基础语法