Extensions 下载

Workspace Settings

我学乖了，项目主要用到什么语言，就建立一个对应语言的workspace，如 C++ 的项目都放在 CPP Folder下就好，这样我们只需要建立一个 .vscode 文件夹。

.vscode 中建立四个文件:

tasks.json – 编译时加入的编译选项
settings.json – 没想清在单个项目有什么用，我一般配全局
launch.json – 用于 LLDB Debug
c_cpp_properties.json – 加头文件/编译路径

这四个文件分别是：

tasks.json

{
  "version": "2.0.0",
  "tasks": [
      {
          "label": "Compile", // 任务名称，与launch.json的preLaunchTask相对应
          "type": "process", // 可以为process或shell
          "command": "/usr/local/opt/llvm/bin/clang++", // 要使用的编译器，C语言用clang
          "args": [
              "${file}",
              "-g", // 生成和调试有关的信息, 如果加上该参数，编译后不仅会生成.out可执行文件，还会生成后缀为.out.dSYM的文件夹，如果不加，调试器会忽略你设的断点
              "-o", // 指定输出文件名，os X和Linux下不加该参数则默认输出a.out，win下默认a.exe
              "${fileDirname}/${fileBasenameNoExtension}", // 指定编译生成结果（.out文件和.out.dSYM文件夹）
              "-Wall", // 开启额外警告
              "-stdlib=libc++", // 静态链接libc++，Linux下似乎会出错，出错的话删掉这行就行
              "-std=c++17", // 这里采用c++17标准（推荐），C语言改成"-std=c11"
          ], // 编译的命令，其实相当于VSC帮你在终端中输了这一串东西
          "group": {
              "kind": "build",
              "isDefault": true // 不为true时command shift B快捷键就要手动选择了
          },
          "options": {
              "cwd": "${workspaceFolder}"
          },
          "presentation": {
              "echo": true,
              "reveal": "always", // 执行任务时是否跳转到终端面板，可以为always，silent，never。具体参见VSC的文档，即使设为never，手动点进去还是可以看到
              "focus": false, // 设为true后可以使执行task时焦点聚集在终端，但对编译C/C++来说，设为true没有意义
              "panel": "shared" // 不同的文件的编译信息共享一个终端面板
          }
      }
  ]
}

settings.json

.vscode 文件夹下的，这个不是全局滴

{
  "editor.snippetSuggestions": "top", // （可选）snippets显示在补全列表顶端，默认是inline
  "files.defaultLanguage": "cpp", // ctrl+N新建文件后默认的语言，c语言改成c即可
  "editor.suggest.snippetsPreventQuickSuggestions": false // clangd的snippets有很多的跳转点，不用这个就必须手动触发Intellisense了
}

launch.json

{
  "version": "0.2.0",
  "configurations": [
      {
          "name": "(lldb) Launch", // 配置名称，将会在启动配置的下拉菜单中显示
          "type": "lldb", // 配置类型，不同编程语言不同,该项由CodeLLDB插件提供
          "request": "launch", // 可以为launch（启动）或attach（附加） 
          "program": "${fileDirname}/bin/${fileBasenameNoExtension}.out", // 将要进行调试的程序的路径
          "args": [], // 程序调试时传递给程序的命令行参数，一般设为空
          "stopAtEntry": false, // 设为true时程序将暂停在程序入口处，相当于在main上打断点
          "cwd": "${fileDirname}", // 调试程序时的工作目录，此为工作区文件夹；改成${fileDirname}可变为文件所在目录
          "environment": [], // 环境变量
          "externalConsole": false, // 使用单独的cmd窗口，与其它IDE一致；为false时使用内置终端
          "internalConsoleOptions": "neverOpen", // 如果不设为neverOpen，调试时会跳到“调试控制台”选项卡，你应该不需要对gdb/lldb手动输命令吧？
          "MIMode": "lldb", // 指定连接的调试器，可以为gdb或lldb，因为使用llvm工具链，所以使用lldb
          "miDebuggerPath": "/usr/local/opt/llvm/bin/lldb", // lldb调试器路径，通过在终端输入 which lldb 命令得到
          "setupCommands": [
              { // 模板自带，好像可以更好地显示STL容器的内容
                  "description": "Enable pretty-printing for lldb", 
                  "text": "-enable-pretty-printing",
                  "ignoreFailures": false
              }
          ],
          "preLaunchTask": "Compile" // 调试前执行的任务，一般为编译程序。与tasks.json的label相对应
      }
  ]
}

c_cpp_properties.json

{
  "configurations": [
      {
          "name": "Mac",
          "includePath": [
              "${workspaceFolder}/**"
          ],
          "defines": ["_DEBUG"],
          "compilerPath": [
              "/usr/bin/g++"
          ],
          "cStandard": "c11",
          "cppStandard": "c++17",
          "intelliSenseMode": "clang-x64"
      }
  ],
  "version": 4
}

全局 settings.json, 通过 Ctrl + Shift + P 打开 Settings.json, 我具体加的配置有：

"clangd.path": [
"/usr/local/opt/llvm/bin/clangd"
],
// 关闭 C/C++ 提供的 IntelliSenseEngine
"C_Cpp.intelliSenseEngine": "Disabled",
// Clangd 运行参数(在终端/命令行输入 clangd --help-list-hidden 可查看更多)
"clangd.onConfigChanged": "restart",
"clangd.path": "/usr/local/opt/llvm/bin/clangd",
"clangd.arguments": [
  // 启用 Clang-Tidy 以提供「静态检查」
  "--clang-tidy",
  // compelie_commands.json 文件的目录位置(相对于工作区，由于 CMake 生成的该文件默认在 build 文件夹中，故设置为 build)
  "--compile-commands-dir=build",
  // 建议风格：打包(重载函数只会给出一个建议）；反可以设置为detailed
  "--completion-style=bundled",
  "--enable-config",
  // 默认格式化风格: 谷歌开源项目代码指南（可用的有 LLVM, Google, Chromium, Mozilla, Webkit, Microsoft, GNU 等）
  "--fallback-style=Google",
  // 启用这项时，补全函数时，将会给参数提供占位符，键入后按 Tab 可以切换到下一占位符，乃至函数末
  // 我选择禁用
  "--function-arg-placeholders=false",
  // 输入建议中，已包含头文件的项与还未包含头文件的项会以圆点加以区分
  "--header-insertion-decorators",
  // 允许补充头文件
  "--header-insertion=iwyu",
  // 让 Clangd 生成更详细的日志
  "--log=verbose",
  // pch优化的位置(memory 或 disk，选择memory会增加内存开销，但会提升性能)
  "--pch-storage=memory",
  // 输出的 JSON 文件更美观
  "--pretty",
  // 建议排序模型
  "--ranking-model=heuristics",
  // 同时开启的任务数量
  "-j=12"
],
// 自动检测 clangd 更新
"clangd.checkUpdates": true,

Tips

当时配好后头文件出了这个问题：

编译是没有问题的，应该是编译器有自动链接要比 vscode-clangd 强，改成 ../kernel/types.h 就可以了，说明它还不能支持相对路径叭，要写全🤔

Linux Update

换在云主机(Ubuntu 20.04LTS)上，需要修改一些东西orz

tasks.json

修改 command 的路径

// {
  "version": "2.0.0",
  "tasks": [
      {
          "label": "Compile", // 任务名称，与launch.json的preLaunchTask相对应
          "type": "process", // 可以为process或shell
          "command": "/usr/bin/clang++", // 要使用的编译器，C语言用clang
          "args": [
              "${file}",
              "-g", // 生成和调试有关的信息, 如果加上该参数，编译后不仅会生成.out可执行文件，还会生成后缀为.out.dSYM的文件夹，如果不加，调试器会忽略你设的断点
              "-o", // 指定输出文件名，os X和Linux下不加该参数则默认输出a.out，win下默认a.exe
              "${fileDirname}/${fileBasenameNoExtension}", // 指定编译生成结果（.out文件和.out.dSYM文件夹）
              "-Wall", // 开启额外警告
              "-stdlib=libc++", // 静态链接libc++，Linux下似乎会出错，出错的话删掉这行就行
              "-std=c++17", // 这里采用c++17标准（推荐），C语言改成"-std=c11"
          ], // 编译的命令，其实相当于VSC帮你在终端中输了这一串东西
          "group": {
              "kind": "build",
              "isDefault": true // 不为true时command shift B快捷键就要手动选择了
          },
          "options": {
              "cwd": "${workspaceFolder}"
          },
          "presentation": {
              "echo": true,
              "reveal": "always", // 执行任务时是否跳转到终端面板，可以为always，silent，never。具体参见VSC的文档，即使设为never，手动点进去还是可以看到
              "focus": false, // 设为true后可以使执行task时焦点聚集在终端，但对编译C/C++来说，设为true没有意义
              "panel": "shared" // 不同的文件的编译信息共享一个终端面板
          }
      }
  ]
}

settings.json

{
  "editor.snippetSuggestions": "top", // （可选）snippets显示在补全列表顶端，默认是inline
  "files.defaultLanguage": "cpp", // ctrl+N新建文件后默认的语言，c语言改成c即可
  "editor.suggest.snippetsPreventQuickSuggestions": false // clangd的snippets有很多的跳转点，不用这个就必须手动触发Intellisense了
}

launch.json

修改下 miDebuggerPath 调试器的路径

{
  "version": "0.2.0",
  "configurations": [
      {
          "name": "(lldb) Launch", // 配置名称，将会在启动配置的下拉菜单中显示
          "type": "lldb", // 配置类型，不同编程语言不同,该项由CodeLLDB插件提供
          "request": "launch", // 可以为launch（启动）或attach（附加） 
          "program": "${fileDirname}/bin/${fileBasenameNoExtension}.out", // 将要进行调试的程序的路径
          "args": [], // 程序调试时传递给程序的命令行参数，一般设为空
          "stopAtEntry": false, // 设为true时程序将暂停在程序入口处，相当于在main上打断点
          "cwd": "${fileDirname}", // 调试程序时的工作目录，此为工作区文件夹；改成${fileDirname}可变为文件所在目录
          "environment": [], // 环境变量
          "externalConsole": false, // 使用单独的cmd窗口，与其它IDE一致；为false时使用内置终端
          "internalConsoleOptions": "neverOpen", // 如果不设为neverOpen，调试时会跳到“调试控制台”选项卡，你应该不需要对gdb/lldb手动输命令吧？
          "MIMode": "lldb", // 指定连接的调试器，可以为gdb或lldb，因为使用llvm工具链，所以使用lldb
          "miDebuggerPath": "/usr/bin/lldb", // lldb调试器路径，通过在终端输入 which lldb 命令得到
          "setupCommands": [
              { // 模板自带，好像可以更好地显示STL容器的内容
                  "description": "Enable pretty-printing for lldb", 
                  "text": "-enable-pretty-printing",
                  "ignoreFailures": false
              }
          ],
          "preLaunchTask": "Compile" // 调试前执行的任务，一般为编译程序。与tasks.json的label相对应
      }
  ]
}

c_cpp_properties.json

这个 name 可以不修改的 ovo

{
  "configurations": [
      {
          "name": "Linux",
          "includePath": [
              "${workspaceFolder}/**"
          ],
          "defines": ["_DEBUG"],
          "compilerPath": [
              "/usr/bin/g++"
          ],
          "cStandard": "c11",
          "cppStandard": "c++17",
          "intelliSenseMode": "clang-x64"
      }
  ],
  "version": 4
}

最后呢，因为之前设置的全局 Settings.json 是在真机上配置的，在 ssh 的客户机上 Extensions 的路径肯定是不一样滴，需要修改的地方分别在 Extensions Settings 中的 SSH 方式为 LLDB 和 Clangd 的扩展指定调试器和编译器的路径

提示：在 Ubuntu 20.04LTS 中清华源的 clangd 是 10.0.0 版本，不适配 VSCode 的 Clangd 扩展，需要升级到 clangd-12 ( Clangd扩展里的路径也记得改改噢! 大声! )