VS Code C/C++项目配置
VS Code C/C++项目配置
1. C/C++项目配置
开发平台:Ubuntu
开发工具:Visual Studio Code
编译配置工具:CMake
调试工具:GDB
API文档查询工具:
1.1 C/C++项目目录结构
比较常见的C/C++项目目录如下图所示:
.vscode
目录:Visual Studio Code项目配置文件存放目录,常包含c_cpp_properties.json、 launch.json、tasks.json,该文件夹一般不作为项目内容提交至Git仓库3rd
:第三方库文件存放目录build
:CMake项目编译配置和可执行文件存放目录,该文件夹一般不作为项目内容提交至Git仓库doc
:项目文档(说明文档、图片、视频等)存放目录include
:头文件(.hpp .h)存放目录src
:源文件(.cpp)存放目录lib
:生成的库文件存放目录,该文件夹一般不作为项目内容提交至Git仓库test
:测试文件存放目录.clang-format
:clang-format工具配置文件,该文件一般不作为项目内容提交至Git仓库main.cpp
:项目启动源文件package.xml
:ROS/ROS2项目专属配置文件,非ROS/ROS2项目不需要包含CMakeLists.txt
:CMake项目配置文件,必须包含Readme.md
:MarkDown格式的项目说明文档,文档内引用的图片建议存放在doc
文件夹下,图片引用路径使用相对路径,方便直接在GitLab网页端展示完整的Readme
以上只是常见的文件夹及文件,可根据项目需求添加自定义的文件夹或文件。
1.2 Visual Studio Code&CMake项目开发配置
Visual Studio Code插件安装列表:
- C/C++ Extension Pack:C++开发套件
- CMake & CMake Tools:CMake项目开发套件
- Doxygen Documentation Generator:快速生成代码注释模板,简单易用
- Clang-Format:按照.clang-format配置文件快速格式化代码
Tips:
在CMakeLists.txt中添加如下编译选项:
set(CMAKE_EXPORT_COMPILE_COMMANDS True)
该编译选项可在build文件夹下生成compile_commands.json文件,可将其配置到c_cpp_properties.json,配置项目为:
"compileCommands": "${workspaceFolder}/build/compile_commands.json"
同时也可将/usr/local/include/**
和/usr/include/**
两个路径添加至includePath
中,因为Ubuntu大部分库都安装在这两个目录下,方便vscode进行代码的跳转和语法检查,示例如下:
{
"configurations": [
{
"name": "Linux",
"includePath": [
"${workspaceFolder}/**",
"/usr/local/include/**",
"/usr/include/**"
],
"defines": [],
"compilerPath": "/usr/bin/gcc",
"cStandard": "c11",
"cppStandard": "gnu++17",
"intelliSenseMode": "linux-gcc-x64",
"configurationProvider": "ms-vscode.cmake-tools",
"compileCommands": "${workspaceFolder}/build/compile_commands.json"
}
],
"version": 4
}
此外,cStandard
和cppStandard
也需要配置成项目使用的C/C++版本,因为vscode以这两个参数而不是CMakeLists.txt中配置的C/C++版本为依据进行代码提示和检查,避免由于两方版本配置不一致导致shell端代码编译通过但是vscode端一直提示错误的情况。
c_cpp_properties.json的生成方式为快捷键:Ctrl+Shift+P后搜索C/C++:Edit Configurations(JSON)
1.3 Visual Studio Code&CMake项目编译配置
常规的CMake项目的编译流程为在shell中进行如下操作:
mkdir buid
cd build/
cmake -DCMAKE_BUILD_TYPE=Debug ..
make
Visual Studio Code要想编译CMake项目就需要将以上流程配置到tasks.json文件中,生成tasks.json具体步骤如下:
- 在VSCode的主菜单中,选择 Terminal->Configure Default Build Task
- 选择 "CMake: build"
- 将在.vscode文件夹下生成一个
tasks.json
文件
tasks.json
文件内容如下:
{
"version": "2.0.0",
"tasks":
[
{
"label": "cmake",
"type": "shell",
"command": "cmake",
"args": [
"-DCMAKE_BUILD_TYPE=Debug",
".."
],
"options": {
"cwd": "${workspaceFolder}/build"
},
},
{
"label": "make",
"type": "shell",
"command": "make",
"args": [],
"options": {
"cwd": "${workspaceFolder}/build"
},
},
{
"label": "build",
"dependsOn": ["cmake", "make"]
}
]
}
task
标签下的每一个花括号都表示一个命令,label
则为该命令的标识,可自定义; type
为命令的类型;command
为具体执行的命令,按需自定义;args
为执行参数,可自定义;cwd
为执行该命令的目录,可自定义;示例解释如下:
- label为
cmake
的任务:执行shell类型的cmake命令,其参数为-DCMAKE_BUILD_TYPE=Debug
和../
,执行时所在的目录为${workspaceFolder}/build
。这个命令等价于在build
目录下执行cmake -DCMAKE_BUILD_TYPE=Debug ..
- label为
make
的任务:执行shell类型的make命令,没有参数,执行时所在的目录为${workspaceFolder}/build
。这个命令等价于在build
目录下执行make
- label为
build
的任务:该任务由cmake和make任务组成,也就是将上面两条命令执行的任务组合成一个build任务,所以执行build
任务相当于在build目录下执行了cmake -DCMAKE_BUILD_TYPE=Debug ..
和make
两条命令,完成了 CMake项目的编译过程
最后,启动Visual Studio Code编译CMake项目的流程为:
- 在VSCode的主菜单中,选择
Terminal -> Run Task…
- 选择要执行的任务,任务名称与
label
对应,按照如上配置,可直接选择build
同时完成cmake
和make
过程
1.4 Visual Studio Code&CMake项目调试配置
Visual Studio Code也使用GDB进行程序调试,相比起命令行工具调试减少了命令的输入,方便了许多。在调试之前务必确保项目配置编译选项为CMAKE_BUILD_TYPE=Debug,否认则可能调试失败。Visual Studio Code调试依赖于launch.json
配置文件,调试配置流程如下:
- 在Visual Studio Code的上方菜单中,选择
Run -> Add Configuration
,会在.vscode文件夹下生成一个空白的launch.json
文件 - 配置
launch.json
内容
{
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "(gdb) Launch",
"type": "cppdbg",
"request": "launch",
"program": "${workspaceFolder}/build/${workspaceFolderBasename}",
"args": [],
"stopAtEntry": false,
"cwd": "${fileDirname}",
"environment": [],
"externalConsole": false,
"MIMode": "gdb",
"setupCommands": [
{
"description": "Enable pretty-printing for gdb",
"text": "-enable-pretty-printing",
"ignoreFailures": true
},
],
"preLaunchTask": "build"
}
]
}
其中需要重点关注的属性为:
program
属性:该属性为可执行文件的完整路径,可执行文件必须是Debug模式下编译生成的args
属性:配置可执行文件的参数,不包括可执行文件名称preLaunchTask
属性:该属性配置调试的前置任务,前置任务名称必须与tasks.json
中的label
对应;表示调试启动之前必须先执行前置任务,该属性也可不写。
Note
Visual Studio Code编译与调试CMake项目并不是强相关的,可以只配置编译或者调试。
2. C/C++代码风格管理
Visual Studio Code可以通过配置Clang-format实现代码风格的管理,clang-format
是 LLVM 开发的用于格式化 C/C++/Java/JavaScript/Objective-C/Objective-C++/Protobuf 等多种语言代码的工具,借助 clang-format 可以实现代码仓库的风格统一,提升开发效率。Visual Studio Code配置Clang-format流程如下:
- Visual Studio Code安装扩展
Clang-Format(Xaver Hellauer)
- 进入vscode中的设置,搜索
formatting
,将c_cpp:formatting
设置为clang-format
- 进入vscode中的设置,搜索
defaultformatter
,将editor:default formatrer
设置为C/C++
- 进入vscode中的设置,搜索
formatonsave
,将editor:format on save
的勾选上 - 重启Visual Studio Code
- 在项目根目录下新建名为
.clang-format
的文件并配置内容,可通过配置项自定义代码风格,Clang-Format插件将自动识别该文件并在代码保存时自动执行格式化。具体配置内容如下:
# 语言: None, Cpp, Java, JavaScript, ObjC, Proto, TableGen, TextProto
Language: Cpp
BasedOnStyle: LLVM
# 访问说明符(public、private等)的偏移
AccessModifierOffset: -4
# 左括号(左圆括号、左尖括号、左方括号)后的对齐: Align, DontAlign, AlwaysBreak(总是在左括号后换行)
AlignAfterOpenBracket: Align
# 连续赋值时,对齐所有等号
AlignConsecutiveAssignments: false
# 连续声明时,对齐所有声明的变量名
AlignConsecutiveDeclarations: false
# 对齐连续位域字段的风格
# AlignConsecutiveBitFields: AcrossEmptyLinesAndComments
# 对齐连续宏定义的风格
# AlignConsecutiveMacros: Consecutive #clang-format 12
# 用于在使用反斜杠换行中对齐反斜杠的选项
AlignEscapedNewlines: Left
# 水平对齐二元和三元表达式的操作数
AlignOperands: Align
# 对齐连续的尾随的注释
AlignTrailingComments: true
# 如果函数调用或带括号的初始化列表不适合全部在一行时
# 允许将所有参数放到下一行,即使BinPackArguments为false
AllowAllArgumentsOnNextLine: true
# 允许构造函数的初始化参数放在下一行
AllowAllConstructorInitializersOnNextLine: true
# 允许函数声明的所有参数在放在下一行
AllowAllParametersOfDeclarationOnNextLine: true
# 允许短的块放在同一行(Always 总是将短块合并成一行,Empty 只合并空块)
AllowShortBlocksOnASingleLine: Empty
# 允许短的case标签放在同一行
AllowShortCaseLabelsOnASingleLine: true
# 允许短的函数放在同一行: None, InlineOnly(定义在类中), Empty(空函数), Inline(定义在类中,空函数), All
AllowShortFunctionsOnASingleLine: Inline
# 允许短的if语句保持在同一行
AllowShortIfStatementsOnASingleLine: true
# 允许短的循环保持在同一行
AllowShortLoopsOnASingleLine: true
# 总是在定义返回类型后换行(deprecated)
AlwaysBreakAfterDefinitionReturnType: None
# 总是在返回类型后换行: None, All, TopLevel(顶级函数,不包括在类中的函数),
# AllDefinitions(所有的定义,不包括声明), TopLevelDefinitions(所有的顶级函数的定义)
# 函数声明返回类型后是否换行(None 自动,All全部,TopLevel...)
AlwaysBreakAfterReturnType: None
# 总是在多行string字面量前换行
AlwaysBreakBeforeMultilineStrings: false
# 总是在template声明后换行
AlwaysBreakTemplateDeclarations: true
# false表示函数实参要么都在同一行,要么都各自一行
BinPackArguments: false
# false表示所有形参要么都在同一行,要么都各自一行
BinPackParameters: true
# 大括号换行,只有当 BreakBeforeBraces 设置为Custom时才有效
BraceWrapping:
# case 语句后面
AfterCaseLabel: true
# class定义后面
AfterClass: true
# 控制语句后面
AfterControlStatement: true
# enum定义后面
AfterEnum: true
# 函数定义后面
AfterFunction: true
# 命名空间定义后面
AfterNamespace: true
# ObjC定义后面
AfterObjCDeclaration: false
# struct定义后面
AfterStruct: true
# union定义后面
AfterUnion: true
# extern 导出块后面
AfterExternBlock: false
# catch之前
BeforeCatch: true
# else之前
BeforeElse: true
# 缩进大括号(整个大括号框起来的部分都缩进)
IndentBraces: false
# 空函数的大括号是否可以在一行
SplitEmptyFunction: false
# 空记录体(struct/class/union)的大括号是否可以在一行
SplitEmptyRecord: false
# 空名字空间的大括号是否可以在一行
SplitEmptyNamespace: false
# 在二元运算符前换行: None(在操作符后换行), NonAssignment(在非赋值的操作符前换行), All(在操作符前换行)
BreakBeforeBinaryOperators: None
# 在大括号前换行: Attach(始终将大括号附加到周围的上下文), Linux(除函数、命名空间和类定义,与Attach类似),
# Mozilla(除枚举、函数、记录定义,与Attach类似), Stroustrup(除函数定义、catch、else,与Attach类似),
# Allman(总是在大括号前换行), GNU(总是在大括号前换行,并对于控制语句的大括号增加额外的缩进), WebKit(在函数前换行), Custom
# 注:这里认为语句块也属于函数
# 大括号的换行规则
BreakBeforeBraces: Custom
# 三元运算操作符换行位置(?和: 在新行还是尾部)
BreakBeforeTernaryOperators: true
# 在构造函数的初始化列表的逗号前换行
BreakConstructorInitializersBeforeComma: false
# 要使用的构造函数初始化式样式
BreakConstructorInitializers: BeforeComma
# 每行字符的限制,0表示没有限制
ColumnLimit: 160
# 描述具有特殊意义的注释的正则表达式,它不应该被分割为多行或以其它方式改变
# CommentPragmas: ''
# 如果为true,则连续的名称空间声明将在同一行上。如果为false,则在新行上声明每个名称空间。
CompactNamespaces: false
# 构造函数的初始化列表要么都在同一行,要么都各自一行
ConstructorInitializerAllOnOneLineOrOnePerLine: false
# 构造函数的初始化列表的缩进宽度
ConstructorInitializerIndentWidth: 4
# 延续的行的缩进宽度
ContinuationIndentWidth: 4
# 去除C++11的列表初始化的大括号{后和}前的空格
Cpp11BracedListStyle: true
# 继承最常用的指针和引用的对齐方式
DerivePointerAlignment: false
# 关闭格式化
DisableFormat: false
# 自动检测函数的调用和定义是否被格式为每行一个参数(Experimental)
ExperimentalAutoDetectBinPacking: false
# 如果为true,则clang格式会为短名称空间添加缺少的名称空间结尾注释,并修复无效的现有名称结束注释
FixNamespaceComments: true
# 需要被解读为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
# 要使用的预处理器指令缩进样式
IndentPPDirectives: AfterHash
# 缩进宽度
IndentWidth: 4
# 函数返回类型换行时,缩进函数声明或函数定义的函数名
IndentWrappedFunctionNames: false
# 保留在块开始处的空行
KeepEmptyLinesAtTheStartOfBlocks: true
# 开始一个块的宏的正则表达式
MacroBlockBegin: ''
# 结束一个块的宏的正则表达式
MacroBlockEnd: ''
# 连续空行的最大数量
MaxEmptyLinesToKeep: 1
# 命名空间的缩进: None, Inner(缩进嵌套的命名空间中的内容), All
NamespaceIndentation: All
# 使用ObjC块时缩进宽度
ObjCBlockIndentWidth: 4
# 在ObjC的@property后添加一个空格
ObjCSpaceAfterProperty: false
# 在ObjC的protocol列表前添加一个空格
ObjCSpaceBeforeProtocolList: true
# 在call(后对函数调用换行的penalty
PenaltyBreakBeforeFirstCallParameter: 2
# 在一个注释中引入换行的penalty
PenaltyBreakComment: 300
# 第一次在<<前换行的penalty
PenaltyBreakFirstLessLess: 120
# 在一个字符串字面量中引入换行的penalty
PenaltyBreakString: 1000
# 对于每个在行字符数限制之外的字符的penalty
PenaltyExcessCharacter: 1000000
# 对每一个空格缩进字符的penalty(相对于前导的非空格列计算)
# PenaltyIndentedWhitespace: 0
# 将函数的返回类型放到它自己的行的penalty
PenaltyReturnTypeOnItsOwnLine: 120
# 指针和引用的对齐: Left, Right, Middle
PointerAlignment: Left
# 允许重新排版注释
ReflowComments: false
# 允许排序#include
SortIncludes: false
# 允许排序 using 声明顺序
SortUsingDeclarations: false
# 在C风格类型转换后添加空格
SpaceAfterCStyleCast: false
# 在逻辑非操作符(!)之后插入一个空格
SpaceAfterLogicalNot: false
# 在 template 关键字后插入一个空格
SpaceAfterTemplateKeyword: false
# 定义在什么情况下在指针限定符之前或之后放置空格
# SpaceAroundPointerQualifiers: Before
# 在赋值运算符之前添加空格
SpaceBeforeAssignmentOperators: true
# 左圆括号之前添加一个空格: Never, ControlStatements, Always
SpaceBeforeParens: ControlStatements
# 空格将在基于范围的for循环冒号之前被删除
SpaceBeforeRangeBasedForLoopColon: true
# [ 前是否添加空格(数组名和[之间,Lambdas不会受到影响)
# 连续多个 [ 只考虑第一个(嵌套数组,多维数组)
SpaceBeforeSquareBrackets: false
# 在空的圆括号中添加空格
SpaceInEmptyParentheses: false
# 在尾随的评论前添加的空格数(只适用于//)
SpacesBeforeTrailingComments: 3
# 在尖括号的<后和>前添加空格
SpacesInAngles: false
# 在容器(ObjC和JavaScript的数组和字典等)字面量中添加空格
SpacesInContainerLiterals: false
# 在C风格类型转换的括号中添加空格
SpacesInCStyleCastParentheses: false
# 如果为true,将在If/for/switch/while条件括号前后插入空格。
SpacesInConditionalStatement: false
# 在圆括号的(后和)前添加空格
SpacesInParentheses: false
# 在方括号的[后和]前添加空格,lamda表达式和未指明大小的数组的声明不受影响
SpacesInSquareBrackets: false
# 标准: Cpp03, Cpp11, Auto
Standard: Cpp11
# tab宽度
TabWidth: 4
# 使用tab字符: Never, ForIndentation, ForContinuationAndIndentation, Always
UseTab: Never
配置完成之后,每次保存文件时都将自动进行格式化并保存。
参考链接:Clang-format官方文档
3. C/C++项目测试配置
单元测试库使用GTest,测试内容作为一个单独的CMake项目存放在test文件夹下,同时该CMake项目作为主CMake项目的子项目存在。配置流程如下:
-
系统安装GTest库
-
主CMake项目CMakeLIsts.txt配置,添加如下内容:
#开启测试
enable_testing()
#包含测试子项目,test_project_dir_name为测试项目所在文件夹名称
add_subdirectory(test_project_dir_name)
- 测试所在CMake项目CMakeLIsts.txt配置,添加如下内容:
#添加GTest库
find_package(GTest REQUIRED)
#添加GTest头文件目录
include_directories(${GTEST_INCLUDE_DIRS})
#构建测试用例可执行文件,具体参数自定义
add_executable(test_name ...)
#链接GTest测试库与pthread,不链接pthread会报错
target_link_libraries(test_name ${GTEST_BOTH_LIBRARIES} pthread)
#注册测试用例,注册测试用例之后可通过make test自动执行测试用例
#注册方式有add_test和gtest_discover_tests两种,二选一
add_test(NAME test_name COMMAND command)
gtest_discover_tests(test_name)
参考链接:GoogleTest官方文档
4. .gitignore文件配置
在使用Git管理CMake项目的过程中,有的文件比如日志,临时文件,编译的中间文件、IDE配置文件一般不提交到代码仓库,这时就需要设置相应的忽略规则来忽略这些文件的提交。Git提供了一个.gitignore
配置文件,只要在这个文件中声明哪些文件你不希望添加到git中去,这样当你使用git add .的时候这些文件就会被自动忽略掉,当然已经被添加追踪的文件再配置进.gitignore
则该配置项就会失效。示例如下:
# 忽略vsc配置文件
.vscode/
# 编译过程文件
build/
# 代码风格配置文件
.clang-format
# 编译结果文件
lib/