clang

clangd

clangd 是一个语言服务器（Language Server），专门为 C/C++ 代码提供智能编辑功能。具有以下功能：

  • 代码补全：智能提示函数、变量、类等

  • 语法检查：实时检查语法错误

  • 代码导航：跳转到定义、查找引用

  • 重构支持：重命名、提取函数等

  • 错误诊断：显示编译错误和警告

clang-format

clang-format 是一个代码格式化工具，通过配置简单易懂的格式化选项，可以在保持代码功能不变的情况下，自动处理缩进、空格、括号、逗号等细节，提高代码的可读性和一致性，减轻代码审查和格式化的工作量，使代码维护更加高效。具有以下功能：

  • 代码风格统一：自动调整缩进、空格、换行等

  • 多种预设风格：Google、LLVM、Microsoft 等

  • 自定义配置：支持 .clang-format 配置文件

  • 批量格式化：可以格式化整个文件或代码块

clangd 与 clangd-format

特性clangdclang-format
主要功能语言服务器，智能编辑代码格式化工具
运行方式后台服务，持续运行按需执行，一次性
输出结果代码提示、错误诊断格式化的代码
配置方式编辑器集成配置.clang-format 文件
使用场景日常代码编辑代码风格统一s

安装

  • ubuntu
sudo apt-get install clangd
sudo apt install clang-format
  • windows

LLVM-CLANG下载连接

安装vscode插件

install_clangd_on_vscode

在vscode中使用

  • 在项目根目录或源代码所在目录下创建一个名为.clang-format的文件。
  • 根据自己的编码风格偏好，在.clang-format文件中指定格式化选项，例如缩进、空格、括号风格等。
  • 可以使用官方文档中提供的样式选项或自定义选项来配置文件。
  • 保存.clang-format文件后，clang-format会在格式化代码时自动读取这些选项。

.clang-format文件详解

  1. clang-format文件是用于配置clang-format的文件，采用基于YAML的格式。文件结构包括一系列的键值对，用于定义不同的格式化选项，其中格式化选项可以嵌套使用，形成层级结构。
  • .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:false
 # 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:200
 # 描述具有特殊意义的注释的正则表达式，它不应该被分割为多行或以其它方式改变
 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:'^(<|"(gtest|isl|json)/)'
    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
 # 第一次在<<前换行的penalty
 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:true
 # 标准: Cpp03, Cpp11, Auto
 Standard:Cpp11
 # tab宽度
 TabWidth:4
 # 使用tab字符: Never, ForIndentation, ForContinuationAndIndentation, Always
 UseTab:Never
 ...
如果不需要重新定义所有的规则，而是基于已有的代码风格模板进行修改，可以使用BasedOnStyle标识来进行部分格式规则的重定义：
 ---
 # We'll use defaults from the LLVM style, but with 4 columns indentation.
 BasedOnStyle: LLVM
 IndentWidth: 4
 ---
 Language: Cpp
 # Force pointers to the type for C++.
 DerivePointerAlignment: false
 PointerAlignment: Left
 ---
 Language: JavaScript
 # Use 100 columns for JS.
 ColumnLimit: 100
 ---
 Language: Proto
 # Don't format .proto files.
 DisableFormat: true
 ---
 Language: CSharp
 # Use 100 columns for C#.
 ColumnLimit: 100
 ...
  • 如果代码文件中有部分代码不希望采用.clang-format进行格式化，可以在这部分代码块的前后使用如下的注释进行标识：
// clang-format off
这两个注释中间的代码不受clang-format的影响
// clang-format on

参考文章

ClangFormat