vscode配置clangd和clang-format

这篇具有很好参考价值的文章主要介绍了vscode配置clangd和clang-format。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

vscode安装和配置

如何安装和配置vscode以搭建c++开发环境,可以查看我的另一篇博客:Windows上最轻量的vscode-C++开发环境搭建。

在这篇博客中,详细介绍了如何安装vscode以及应该安装哪些插件。这里不再赘述。

vscode中想使用clangd来作为语言服务器、clang-format来作为代码格式化工具,还需要额外安装以下两个插件:

vscode配置clangd和clang-format
clangd插件
vscode配置clangd和clang-format
clang-format插件

关于什么是clangd,什么是clang-format,这里做一下总结性说明:

clangd : 代码服务器,提供基础的代码跳转、代码补全等功能;

clang-format: 代码格式化器,当我们使用编辑器对代码进行格式化时,需要提供一个代码格式化器,用来对我们的代码进行格式化。

格式化的意思是:该缩进的地方缩进,该对齐的地方对齐,以使我们的代码看起来更加整洁和干净。

clangd配置

想要使用clangd作为语言服务器,一些必要的配置是少不了的。本文中,假设工作空间文件夹是my_project,文件目录结构如下:

my_project
    |-- include
        |-- a.h
        |-- b.h
        |-- c.hpp
    |-- source
        |-- a.cpp
        |-- b.cpp
        |-- d.cpp
    |-- CMakeLists.txt

这是一个最简单的基于cmake构建系统的c++工程结构。其中,include文件夹是项目的头文件目录;source文件夹是项目的源文件目录;CMakeLists.txt是cmake构建的入口文件。

1. clangd可执行文件下载

在使用clangd之前,需要先下载clangd的可执行文件。

  1. 如果是在linux上,直接运行以下命令进行安装:
  sudo apt install clangd
  1. 如果是在windows上,则在这里下载。
vscode配置clangd和clang-format
clangd下载页

2. vscode配置clangd插件

在上面的示例工程下,新建.vscode/settings.json文件,或者按下F1并输入settings,选择首选项:打开工作区设置(json),如下图所示:

vscode配置clangd和clang-format

就会在当前工作目录下创建当前工作区的设置文件,这个文件是专门针对当前工作区的设置文件,里面的设置项会取代全局的设置项,从而只在当前工作区生效。

vscode的clangd插件有如下配置项:

  1. clangd.fallbackFlags: 设置头文件搜索路径

  2. clangd.path: clangd的可执行文件路径

  3. clangd.arguments: clangd服务运行时传递给可执行文件的参数

  4. clangd.detectExtensionConflicts: 设置clangd是否检测扩展的冲突

  5. clangd.serverCompletionRanking: 设置是否在键入时,对补全结果进行排序。

clangd的其他选项没有那么重要,这里就不一一列举。

一个稍显完整的clangd配置如下:

{
    "clangd.fallbackFlags": [
        "-I${workspaceFolder}/include"
    ],
    // "clangd.path": "the/path/to/clangd/executable/on/windows",
    "clangd.detectExtensionConflicts": true,
    "clangd.arguments": [
        // 在后台自动分析文件(基于complie_commands)
        "--background-index",
        // 标记compelie_commands.json文件的目录位置
        "--compile-commands-dir=build",
        // 同时开启的任务数量
        "-j=12",
        // 告诉clangd用那个clang进行编译,路径参考which clang++的路径
        // "--query-driver=/usr/bin/clang++",
        // clang-tidy功能
        "--clang-tidy",
        "--clang-tidy-checks=performance-*,bugprone-*",
        // 全局补全(会自动补充头文件)
        "--all-scopes-completion",
        // 更详细的补全内容
        "--completion-style=detailed",
        // 补充头文件的形式
        "--header-insertion=iwyu",
        // pch优化的位置
        "--pch-storage=disk"
    ],
    "clangd.serverCompletionRanking": true,
}

以上clangd的配置中有两个地方需要注意:

  1. fallbackFlags数组中,每一项前面都需要加上-I;

  2. arguments数组中,compile-commands-dir选项的值,一般为cmake的构建目录。cmake在构建时可以选择输出compile-commands.json,具体如何开启不在本文的范围内,可自行百度。

clangd的具体参数解释,可以在命令行输入clangd --help进行查看。

clang-format配置

clang-formatllvm提供的代码格式化工具,使用该工具,可以按照设定的规则来进行代码的格式化,比如:

花括号后是否回车?

指针和引用的符号,是居中对齐?左对齐?还是右对齐?

通过配置clang-format的格式化规则,可以以各种各样的风格来格式化代码。同时,clang-format提供了对C/C++/Java/JavaScript/JSON/Objective-C/Protobuf/C#等代码的格式化功能。

clang-format默认提供了7中风格的格式化,分别为:LLVMGNUGoogleChromiumMicrosoftMozillaWebkit。令行里通过clang-format --help,可以看到--style的说明。

clang-format的官方文档地址为:clang-format官方文档。

1. .clang-format

.clang-format文件,是clang-format格式化器所使用的格式化配置文件,当使用vscode进行当前工作目录的代码格式化时,这个文件的配置就是我们格式化的依据。

clang-format程序,提供了一种快速生成.clang-format文件的命令,命令如下:

clang-format -style=llvm -dump-config > .clang-format

这条命令会在当前目录下生成一个.clang-format文件,其中的-style=llvm的意思是,生成的.clang-format文件,是llvm风格的。

clang-format的-style选项支持两种方式:=file=llvm之类,其中=file需要将.clang-format文件或者_clang-format文件放到工程目录下。.clang-format文件使用YAML格式,如下所示:

key1 : value1
key2 : value2
# 注释

配置文件可以使用language:参数表示不同的编程语言的配置区间,每一个language:参数都将配置文件分割为各自编程语言的配置。多语言配置的.clang-format文件的示例如下:

---
# 表示当前配置文件是基于llvm风格的
BasedOnStyle: LLVM
# 默认的缩进宽度是4个空格
IndentWidth: 4
---
# 当前配置语言的区段是c++
Language: Cpp
DerivePointerAlignment: false
# 指针的对齐方式为左对齐
PointerAlignment: Left
---
# 当前配置语言为JS
Language: JavaScript
# 代码列数的最大值为100
ColumnLimit: 100
---
# 当前配置语言为protobuf
Language: Proto
# 表示不格式化protobuf代码
DisableFormat: true
---
# 表示当前语言为 c#
Language: CSharp
# 表示c#代码的单行字符限制为100
ColumnLimit: 100
...

选项的官方文档地址为:.clang-format选项的官方文档地址。

一个配置好的C++的格式化配置文件如下:clangformat详细配置和解释及效果

2. vscode关于clang-format的设置

首先当然是要下载clang-format的可执行文件:

  1. linux上直接使用sudo apt install clang-format进行下载

  2. windows上,可以通过msys2下载llvm编译器(具体操作不做赘述),也可以在llvm的github仓库里下载。下载内容如下:

vscode配置clangd和clang-format
llvm下载内容

下载完llvm的windows安装包之后,在bin目录下,有clang-format.exe文件。然后在工程目录下的.vscode/settings.json文件中,指定clang-format.exe的绝对路径即可。配置如下所示:

{
    "clang-format.executable": "E:\\LLVM\\bin\\clang-format.exe"
}

但是只有上述内容还不够,除了上面一节提到的clang-format的配置文件.clang-format之外,还需要在工作目录的设置文件中,添加一下内容:

{
    "[cpp]": {
        // 在cpp文件中,编辑器在保存的时候进行格式化
        "editor.formatOnSave": true,
        // 在cpp文件中,编辑器在打字的时候进行格式化
        "editor.formatOnType": true,
        // 在cpp文件中,编辑器在粘贴的时候进行格式化
        "editor.formatOnPaste": true,
        // 在cpp文件中,编辑器的默认格式化器为 "xaver.clang-format"
        // 这里的"xaver.clang-format"就是我们安装的clang-format
        // vscode插件
        "editor.defaultFormatter": "xaver.clang-format"
    }
}

有了以上内容,我们在写c++代码时,就可以享受到clangd作为语言服务器的快速跳转和自动补全的功能,以及clang-format的代码格式化功能。

总结

经过上述操作,我们最终的工作目录,应该有以下内容:

my_project
    |-- .vscode
        |-- settings.json
    |-- include
        |-- a.h
        |-- b.h
        |-- c.hpp
    |-- source
        |-- a.cpp
        |-- b.cpp
        |-- d.cpp
    |-- CMakeLists.txt
    |-- .clang-format

一个较为完整的vscode工作区设置文件,里面关于clangd和clang-format的设置应该有以下内容:

{
    // 使用clangd作为语言服务器是,会与微软的智能感知引擎产生冲突
    // 想使用clangd,就需要禁用微软的只能感知引擎。
    "C_Cpp.intelliSenseEngine": "disabled",
    "[cpp]": {
        "editor.formatOnSave": true,
        "editor.formatOnType": true,
        "editor.formatOnPaste": true,
        "editor.defaultFormatter": "xaver.clang-format"
    },
    "clangd.fallbackFlags": [
        // 工作区的头文件包含路径的数组
        "-I${workspaceFolder}/include"
    ],
    "clangd.path": "clangd/executable/path",
    "clangd.detectExtensionConflicts": true,
    "clangd.arguments": [
        // 在后台自动分析文件(基于complie_commands)
        "--background-index",
        // 标记compelie_commands.json文件的目录位置
        "--compile-commands-dir=build",
        // 同时开启的任务数量
        "-j=12",
        // clang-tidy功能
        "--clang-tidy",
        "--clang-tidy-checks=performance-*,bugprone-*",
        // 全局补全(会自动补充头文件)
        "--all-scopes-completion",
        // 更详细的补全内容
        "--completion-style=detailed",
        // 补充头文件的形式
        "--header-insertion=iwyu",
        // pch优化的位置
        "--pch-storage=disk"
    ],
    "clangd.serverCompletionRanking": true,
    "clang-format.executable": "path/to/clang-foramt/executable"
}

clangd作为语言服务器,其在代码跳转上,比微软出的c/c++插件速度快得多。同时,使用clang-format进行代码格式化,可以根据我们自己公司的代码规范进行配置,使我们可以更加专注于业务功能的开发,而不必在代码格式的细节上花费过多时间。文章来源地址https://www.toymoban.com/news/detail-495208.html

到了这里,关于vscode配置clangd和clang-format的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • clang-format格式化代码

    Clang-Format可用于格式化(排版)多种不同语言的代码。其自带的排版格式主要有:LLVM, Google, Chromium, Mozilla, WebKit等; 利用style参数配置风格。通过编写 .clang-format 文件,可以实现代码风格的配置。 [vscode-clang-format]https://github.com/xaverh/vscode-clang-format 在.vscode/setting.json中添加 Acc

    2024年02月13日
    浏览(61)
  • C++-使用clang-format格式化代码

    clang-format既是一个库,也是一个单独的工具,它可以自动格式化代码。下面我们介绍如何在QtCreator中使用clang-format。 点击帮助-关于插件,勾选Beautifier 重启后,点击工具-选项-Beautifier-Clang Format,选择使用File定义风格 windows下,在.pro目录下创建.clang-format文件,linux下,在用户

    2024年02月13日
    浏览(57)
  • 为vscode配置clangd

    clangd能提供更好的补全和提示,自带检查一些warning的问题,可以减少大家未来找存在的warning的时间。经过配置可以在unittest和timetest中也实现自动补全,平均速度比vscode c/c++插件更快。 在插件市场搜索clangd。安装即可。注意c/c++可以不用卸载,否则调试可能会有点问题。 在

    2023年04月08日
    浏览(42)
  • 【VS】visual studio 代码格式化工具--clang-format

    分别表示格式化选中代码与格式化文档。、 虽然现在的🆚022 已经内置了,但是大部分的流程都是一样的 就生成了.clang-format文件: 附.clang-format文件:

    2024年02月11日
    浏览(81)
  • 【C++】Clang-Format:代码自动格式化(看这一篇就够了)

    Clang-format格式化C代码 官方参考文档: Clang-Format Style Options — Clang 16.0.0git documentation (llvm.org) ClangFormat — Clang 16.0.0git documentation (llvm.org) 1.引言安装 1.1引言 进入公司之后,会发现每个公司都有自己的代码规范,针对于其中的代码格式规范,手动去控制十分繁琐,因此这里提供

    2024年02月04日
    浏览(87)
  • VScode clangd 插件浏览 linux 源码

    VScode clangd 插件浏览代码却决于 compile_commands.json 文件 生成该文件有很多种方法 bear 命令 linux 内核脚本 cmake 编译选项 VScode 插件安装 在 VScode 插件商城搜索安装即可 clangd 安装 方法一 插件下载好之后任意打开一个 C/CPP 文件,vscode 下方会出现弹窗直接 install 即可(若网络原因

    2024年02月06日
    浏览(53)
  • VSCode使用clangd构建Linux驱动开发环境

    最初在使用Linux内核源码进行驱动开发时,由于没有代码补全、自动提示等功能写起来十分不方便,虽然有人使用Source Insight来阅读源码,但是我用起来还是感觉怪怪的,有时间同一个函数会找到很多的定义,不便判断。在调用层次方面,还是clangd更好用。 Clangd 是一个基于

    2024年01月16日
    浏览(66)
  • VScode 结合clangd 构建linux源代码阅读环境

    上一篇文章:VScode 结合Global构建linux源代码阅读环境 ,介绍了在VS Code工具中通过remote-ssh远程登陆到Linux远程服务器,使用Global构建linux源代码阅读环境,对linux kernel代码进行解析,实现全局搜索、自动跳转、代码补全等功能,但是Global工具在建立代码索引数据时,将整个Li

    2023年04月16日
    浏览(45)
  • 【vscode基于clangd实现Android/Linux代码跳转】

    背景: 在开发大型工程例如Android或Linux时若我们使用vscode搭配官方的C/C++插件使用发现,经常很多代码都无法跳转,代码补全功能几乎是废的,通过网友以及同事身边了解之后发现 vscode+clangd可以实现代码任意跳转补全等功能 ,因此本文通过讲解如何配置clangd相关环境实现高

    2024年02月11日
    浏览(43)
  • 使用VScode + clangd 阅读 c/c++ 源码环境搭建

    在嵌入式软件开发的工作中,我们常常需要分析C/C++代码,比如linux kernel 的代码,而公司的代码一般都会存放在服务器中,服务器一般是linux,且无法联网,我们只能通过本地笔记本ssh访问服务器,这就导致阅读linux 源码时,需要跳转定义、声明时比较麻烦,本文就介绍了使

    2024年02月10日
    浏览(50)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包