koder code editor使用教程_使用clangformat，从此格式不再烦恼

于 2020-11-19 17:54:46 发布
阅读量1.1k 收藏
点赞数
文章标签： koder code editor使用教程

测试环境

  • 操作系统：

    Ubuntu 18.04/Ubuntu 20.04

  • 编辑器：

    VS Code

  • 编程语言：

    C/C++

为什么要使用 clang-format

小伙伴们是不是经常吵，tab是两格还是四格，是用空格符号还是tab符号？左大括号是放到行的末尾还是放到下一行的开头？那就用clang-format吧，以后可以再也不用因为代码格式问题而吵架了。 b5fecfae452f06e5b095e2d6b3eefc22.png

先看一下在Ubuntu系统中的VS Code环境使用clang-format的效果吧：

752f1ab0510b4efddb5def956333e2cc.gif

我们随便输入了一些代码，直接不考虑任何格式，然后，按Ctrl + S来保存代码，它的格式就立马被修正了：该对齐的地方对齐了，该有空格的地方有空格了！是不是非常方便呢？下面来看一下，如何达到这个效果吧。

安装clang-format

在Ubuntu系统中安装clang-format，可以使用指令：

sudo apt-get install clang-format

网上也有一些教程使用的是LLVM的clang-format，也是可以的，不过那个文件比较大，下载起来要慢一些， 配置起来也稍微有一些不一样。

安装完成之后，我们可以在/usr/bin/文件夹内可以找到clang-format-6.0等文件。

配置VS Code

所有在VS Code菜单里配置的选项，最终都会以文本的形式保存在~/.config/Code/User/settings.json这个文件当中，所以，我们在这里选择直接在这个文件中进行配置。最主要的配置有两个：

"Clang_format_style": "file",
"editor.formatOnSave": true,

  • 第一行里的file，是指使用文件，不是指要使用的文件的路径哦。

    它还可以是google，即采用Google公司的代码规范；

    也可以是其他的。

  • 第二行也是非常重要的，将它设置为true，则点击Ctrl +S的时候，VS Code即会立即执行clang-format格式操作。

文后我们附上文件settings.json的具体内容，小伙伴们就可以知道是在具体的哪个位置上做以上配置啦。

.clang-format

在上面的配置中，我们选择使用file来格式化我们的代码，这里的file，就是.clang-format，它可以放在一个工程的根目录下即可。比如，我们范例工程为cpp-project，该工程下有以下文件(使用tree -a指令查看)：

cpp-project
├── .clang-format
├── main.cpp
└── Makefile

文后我也会附上.clang-format文件的具体内容。

对于不同的习惯，可以修改这个文件。这个文件可以放在一个工程文件的根目录下，这样小伙伴在一起工作的时候，同一个工程，都是同一个格式了。具体的参数，还请小伙伴们自行研究吧。

临时关闭clang-format

代码里面可以临时关闭文件格式，方法如下：

#clang-format off// 不想被格式化的代码#clang-format on

有兴趣的小伙伴们，可以自行实验一下吧。

相关文件内容

settings.json
{
    "files.hotExit": "onExit",
    "editor.tabSize": 4,
    "workbench.editor.enablePreview": false,
    "C_Cpp.updateChannel": "Insiders",
    "editor.detectIndentation": false,
    "files.autoSave": "afterDelay",
    "workbench.iconTheme": "vscode-icons",
    "editor.fontSize": 16,
    "cSpell.enabledLanguageIds": [
        "asciidoc",
        "c",
        "cpp",
        "csharp",
        "css",
        "git-commit",
        "go",
        "handlebars",
        "haskell",
        "html",
        "jade",
        "java",
        "javascript",
        "javascriptreact",
        "json",
        "jsonc",
        "less",
        "markdown",
        "php",
        "plaintext",
        "pug",
        "python",
        "restructuredtext",
        "rust",
        "scala",
        "scss",
        "text",
        "typescript",
        "typescriptreact",
        "yaml",
        "yml"
    ],
    "[cpp]": {
        "editor.defaultFormatter": "ms-vscode.cpptools"
    },
    "Clang_format_style": "file",
    "C_Cpp.clang_format_path": "/usr/bin/clang-format",
    "editor.formatOnSave": true,
}
.clang-format

(首先感谢某网友提供的模板文件)

---
# 语言: None, Cpp, Java, JavaScript, ObjC, Proto, TableGen, TextProto
Language:    Cpp
# BasedOnStyle:    LLVM
# 访问说明符(public、private等)的偏移
AccessModifierOffset:    -4
# 开括号(开圆括号、开尖括号、开方括号)后的对齐: Align, DontAlign, AlwaysBreak(总是在开括号后换行)
AlignAfterOpenBracket:    Align
# 连续赋值时，对齐所有等号
AlignConsecutiveAssignments:    true
# 连续声明时，对齐所有声明的变量名
AlignConsecutiveDeclarations:    true
# 左对齐逃脱换行(使用反斜杠换行)的反斜杠
AlignEscapedNewlinesLeft:    true
# 水平对齐二元和三元表达式的操作数
AlignOperands:    true
# 对齐连续的尾随的注释
AlignTrailingComments:    true
# 允许函数声明的所有参数在放在下一行
AllowAllParametersOfDeclarationOnNextLine:    true
# 允许短的块放在同一行
AllowShortBlocksOnASingleLine:    false
# 允许短的case标签放在同一行
AllowShortCaseLabelsOnASingleLine:    false
# 允许短的函数放在同一行: None, InlineOnly(定义在类中), Empty(空函数), Inline(定义在类中，空函数), All
AllowShortFunctionsOnASingleLine:    Empty
# 允许短的if语句保持在同一行
AllowShortIfStatementsOnASingleLine:    false
# 允许短的循环保持在同一行
AllowShortLoopsOnASingleLine:    false
# 总是在定义返回类型后换行(deprecated)
AlwaysBreakAfterDefinitionReturnType:    None
# 总是在返回类型后换行: None, All, TopLevel(顶级函数，不包括在类中的函数),
#   AllDefinitions(所有的定义，不包括声明), TopLevelDefinitions(所有的顶级函数的定义)
AlwaysBreakAfterReturnType:    None
# 总是在多行string字面量前换行
AlwaysBreakBeforeMultilineStrings:    false
# 总是在template声明后换行
AlwaysBreakTemplateDeclarations:    true
# false表示函数实参要么都在同一行，要么都各自一行
BinPackArguments:    true
# false表示所有形参要么都在同一行，要么都各自一行
BinPackParameters:    true
# 大括号换行，只有当BreakBeforeBraces设置为Custom时才有效
BraceWrapping:
  # class定义后面
  AfterClass:    false
  # 控制语句后面
  AfterControlStatement:    false
  # enum定义后面
  AfterEnum:    false
  # 函数定义后面
  AfterFunction:    false
  # 命名空间定义后面
  AfterNamespace:    false
  # ObjC定义后面
  AfterObjCDeclaration:    false
  # struct定义后面
  AfterStruct:    false
  # union定义后面
  AfterUnion:    false
  # catch之前
  BeforeCatch:    true
  # else之前
  BeforeElse:    true
  # 缩进大括号
  IndentBraces:    false
# 在二元运算符前换行: None(在操作符后换行), NonAssignment(在非赋值的操作符前换行), All(在操作符前换行)
BreakBeforeBinaryOperators:    NonAssignment
# 在大括号前换行: Attach(始终将大括号附加到周围的上下文), Linux(除函数、命名空间和类定义，与Attach类似),
#   Mozilla(除枚举、函数、记录定义，与Attach类似), Stroustrup(除函数定义、catch、else，与Attach类似),
#   Allman(总是在大括号前换行), GNU(总是在大括号前换行，并对于控制语句的大括号增加额外的缩进), WebKit(在函数前换行), Custom
#   注：这里认为语句块也属于函数
BreakBeforeBraces:    Custom
# 在三元运算符前换行
BreakBeforeTernaryOperators:    true
# 在构造函数的初始化列表的逗号前换行
BreakConstructorInitializersBeforeComma:    false
# 每行字符的限制，0表示没有限制
ColumnLimit:    80
# 描述具有特殊意义的注释的正则表达式，它不应该被分割为多行或以其它方式改变
CommentPragmas:    '^ IWYU pragma:'
# 构造函数的初始化列表要么都在同一行，要么都各自一行
ConstructorInitializerAllOnOneLineOrOnePerLine:    false
# 构造函数的初始化列表的缩进宽度
ConstructorInitializerIndentWidth:    4
# 延续的行的缩进宽度
ContinuationIndentWidth:    4
# 去除C++11的列表初始化的大括号{后和}前的空格
Cpp11BracedListStyle:    false
# 继承最常用的指针和引用的对齐方式
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:    '^(    Priority:    3
  - Regex:    '.*'
    Priority:    1
# 缩进case标签
IndentCaseLabels:    false
# 缩进宽度
IndentWidth:    4
# 函数返回类型换行时，缩进函数声明或函数定义的函数名
IndentWrappedFunctionNames:    false
# 保留在块开始处的空行
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
# 第一次在<PenaltyBreakFirstLessLess:    120
# 在一个字符串字面量中引入换行的penalty
PenaltyBreakString:    1000
# 对于每个在行字符数限制之外的字符的penalty
PenaltyExcessCharacter:    1000000
# 将函数的返回类型放到它自己的行的penalty
PenaltyReturnTypeOnItsOwnLine:    60
# 指针和引用的对齐: Left, Right, Middle
PointerAlignment:    Left
# 允许重新排版注释
ReflowComments:    true
# 允许排序#include
SortIncludes:    true
# 在C风格类型转换后添加空格
SpaceAfterCStyleCast:    false
# 在赋值运算符之前添加空格
SpaceBeforeAssignmentOperators:    true
# 开圆括号之前添加一个空格: Never, ControlStatements, Always
SpaceBeforeParens:    ControlStatements
# 在空的圆括号中添加空格
SpaceInEmptyParentheses:    false
# 在尾随的评论前添加的空格数(只适用于//)
SpacesBeforeTrailingComments:    2
# 在尖括号的前添加空格
SpacesInAngles:    true
# 在容器(ObjC和JavaScript的数组和字典等)字面量中添加空格
SpacesInContainerLiterals:    true
# 在C风格类型转换的括号中添加空格
SpacesInCStyleCastParentheses:    true
# 在圆括号的(后和)前添加空格
SpacesInParentheses:    true
# 在方括号的[后和]前添加空格，lamda表达式和未指明大小的数组的声明不受影响
SpacesInSquareBrackets:    false
# 标准: Cpp03, Cpp11, Auto
Standard:    Cpp11
# tab宽度
TabWidth:    4
# 使用tab字符: Never, ForIndentation, ForContinuationAndIndentation, Always
UseTab:    Never
weixin_39729837
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值