简体中文

English

简体中文

English

外观

Git 安装

  Git 是将所作的变更上传到仓库、拉取运行环境、进行差异追踪所必要的工具，你可以在它的 官方网站 下载到它。

  Git 的安装可以参考一下衡山派Git安装步骤

安装VSCode代码编辑器

我们打开VSCode的官方网站VScode下载

  1. 点击下载安装包
  2. 我们直接双击安装包，即可进行安装
  • 安装位置（切记不要使用中文路径！！！）
  • 附加任务【请注意！！这个很重要!!】选择完成之后点击下一步即可！

  出现下面的页面即可！！

  1. 重启电脑（为了使设置生效）

  安装插件

  重启完成之后我们就可以安装插件了

  我们主要安装的插件就是下面的这些：

  • Chinese (Simplified) (简体中文) Language Pack for Visual Studio Code
  • C/C++ IntelliSense

  我们直接打开VSCode软件，点击下面小图片，进入扩展商店！

  界面汉化

  我们先安装Chinese (Simplified) (简体中文) Language Pack for Visual Studio Code，这是可以让界面汉化的工具！

  在扩展商城搜索该插件的名字，选张第一个，点击Install进行安装即可！

  这里我已经安装过了，所以不会显示安装按钮！！

  这个插件安装完成之后VSCode会在右下角提示你重启，点击Restart重启即可将界面变为中文！！

  先去扩展商店查看下扩展Chinese (Simplified) (简体中文) Language Pack for Visual Studio Code是否已经安装好了！

  如果安装好了那就说明不是这个问题，就可以下一步了！

  1. 打开显示（View）菜单，选择命令面板（Command Palette）菜单项或（Ctrl+Shift+P）快捷键 打开命令面板。
  2. 在命令面板中，输入Configure Display Language，选择Configure Display Language命令，显示已安装的语言包列表。
  1. 在已安装的语言包列表中选择需要切换的语言包。
  1. 根据提示重启软件

  C/C++编程环境扩展

  我们直接打开扩展商城，在里面搜索C/C++ IntelliSense 然后点击安装！！

  安装第一个即可！！

  因为我们不需要使用这个插件指定编译器，所以我们安装好之后就可以使用了。仅仅使用它的代码提示和格式检查！

Python 安装

  没有安装的可以参考以下步骤安装：python下载

  在安装的时候再第一个界面勾选Add python.exe to PATH 其他保持不变默认安装即可。

关于环境加载报错加密错误

如下图所示：

原因是你安装的python是Arm64的，需要下载amd64的python版本

在VScode 的 json 中设置 terminal.integrated.profiles.windows

初始状态如下所示：

在配置环境的时候发现并没有 terminal.integrated.profiles.windows ，而直接在setting.json里进行编辑则会报错，这个时候需要对环境进行配置，首先要把终端窗口从底部拉上来，按照图中箭头所示点击：

进入配置终端设置页面之后，需要找到"terminal.integrated.profiles.windows"这一栏，由于是按照首字母排序的，需要翻到p开头的地方，点击在“setting.json中编辑”即可，也可以直接输入 terminal.integrated.profiles.windows 如下图：

在里面添加其命令即可，命令如下所示：

c
"SF32": {
    "path": "C:\\WINDOWS\\System32\\WindowsPowerShell\\v1.0\\powershell.exe",
    "args": [
        "-ExecutionPolicy",
        "Bypass",
        "-NoExit",
        "-File",
        "D:\\SIFLI\\SiFli-SDK\\export.ps1"
    ]
}
在 VSCode 配置 Clangd

注：连接来自于思澈论坛ZhangRiven大佬开源

  Clangd官网配置说明 Clangd Configuration

  命令 clangd -h

准备环境

  安装最新版Clangd。建议从LLVM的Github Release下载，Windows可选择LLVM-xx.x.x-win64.exe下载，会附带安装最新的Clangd，安装时记得勾选添加环境变量。

  安装完成后，在重新打开的终端中使用命令clangd --version检查一下。如果没有下面输出，需要检查一下环境变量是否添加。

shell
> clangd --version
clangd version 20.1.0
Features: windows
Platform: x86_64-pc-windows-msvc

配置Clangd

1、根据Clangd Configuration/File的说明，可配置两个YAML文件（project configuration和user configuration）。

  • 分两个文件主要是为了区分不同工程的共享和私有设置。- 例如提示、补全配置适合所有工程共享。- 编译器和compile-command目录适合设置工程私有。 2、user configuration
  • 根据你的系统，在对应路径下新建config.yaml文件：
    • Windows: %LocalAppData%\clangd\config.yaml
    • macOS: ~/Library/Preferences/clangd/config.yaml
    • Linux and others: $XDG_CONFIG_HOME/clangd/config.yaml
  • 写入下面配置，配置作用在Clangd Configuration查询
shell
# https://clangd.llvm.org/config

# CompileFlags:
# Add: [-Wall]
# Remove:
# CompilationDatabase:
# Compiler:
# BuiltinHeaders:

Completion:
ArgumentLists: Delimiters

InlayHints:
BlockEnd: true
DefaultArguments: true
TypeNameLimit: 0

Hover:
ShowAKA: true

3、project configuration

  • 在项目或父目录中新建.clangd文件
  • 教一个小寄巧，工程其实是可以放在SDK文件夹外的，并且SDK可以用git checkout切换版本。所以建议将sf32工程都放在SDK外的同一个文件夹下，这样也只需要在共有的父目录放一个.clangd即可。
  • 写入下面配置，注意编译器路径要根据实际的来。
shell
# YAML
# https://clangd.llvm.org/config

CompileFlags:
Add: []
Remove: []
Compiler: C:/Users/用户目录/.sifli/tools/arm-none-eabi-gcc/14.2.1/bin/arm-none-eabi-gcc

配置VSCode工程

1、在VSCode中安装LLVM官方插件Clangd

2、打开插件设置，添加下面的配置（或直接添加到settings.json）。

  • 如有或未来会有多个C/C++开发环境，强烈建议设置为Workspace Setting，以对工程进行单独配置。
  • compile-commands-dir=：compile_commands.json所在路径，需要根据实际的板子编译生成的目录修改。
  • query-driver=：编译器路径的通配符，我使用官方工具部署的编译器路径。
shell
{
    "clangd.arguments": [
        "--background-index",
        "--background-index-priority=low",
        "--clang-tidy",
        "--completion-style=detailed",
        "--fallback-style=Google",
        "--function-arg-placeholders=false",
        "--header-insertion=never",
        "--header-insertion-decorators",
        "--import-insertions",
        "--rename-file-limit=0",
        "--enable-config",
        "-j=24",
        "--pch-storage=memory",
        "--pretty",
        "--compile-commands-dir=${workspaceFolder}/project/build_sf32lb52-nano_52j_hcpu",
        "--query-driver=${userHome}/.sifli/tools/arm-none-eabi-gcc/14.2.1/bin/arm-none-eabi-g*"
    ],
}

3、重启IDE：ctrl+shift+p，输入reload window，回车。

4、打开main.c文件，等待一小会，能看到#include "xxx"下面都有横线就是基本成功了。

5、ctrl+~查看Output，选择Clangd，检查有没有E[时间戳]的报错，没有的话恭喜你配置成功了。

特别提醒

  • Clangd插件配置的是Workspace，则新项目也需要配置一下。
  • 要正确获取到C标准库的头文件路径，需要确保settings.json中--query-driver通配符要和.clangd中的Compiler:项匹配上，如前文中的一样。
power shell 不在支持的选项

报错下图所示：

这个问题是因为powershell 版本的问题，需要更新到 PowerShell 7.5 (latest stable version)。

c
winget install --id Microsoft.PowerShell --source winget

安装完毕重启电脑，打开powershell，切换为 PowerShell 7.5 进行环境加载，如下图所示：

在这个里面执行 .\export.ps1 命令即可，后续开发也将使用这个windows terminal窗口进行编译。