[![pipeline status](http://git.midea.com/DEP-MITBG/dep-mt/fan-group/fanplatformng/badges/master/pipeline.svg)](http://git.midea.com/DEP-MITBG/dep-mt/fan-group/fanplatformng/-/commits/master) [![coverage report](http://git.midea.com/DEP-MITBG/dep-mt/fan-group/fanplatformng/badges/master/coverage.svg)](http://git.midea.com/DEP-MITBG/dep-mt/fan-group/fanplatformng/-/commits/master)

# 所需开发环境、工具
|         环境          |         用途         |                               备注                               |
| :-------------------: | :------------------: | :--------------------------------------------------------------: |
|        IAR 8.4        |   MCU程序编译调试    |                             自行安装                             |
|  Visual Studio 2022  |  仿真调试、单元测试  |                  自行安装，需要安装C++开发环境                   |
| Matlab/Simulink 2020b |       仿真测试       |                             自行安装                             |
|         xmake         |   单元测试构建调试   |       tools目录下有安装包，配合vscode xmake extension使用        |
|        clangd         | 代码提示、转跳、补全 | 可直接使用tools目录下可执行文件，配合vscode clangd extension使用 |
|        Python         |      自动化测试      |                     自行安装，建议使用conda                      |
|        doxygen        |       文档生成       |                             自行安装                             |

# VS code开发环境配置说明

**注:请先完成基本工具的安装**

## xmake扩展安装配置（需要安装xmake，Visual Studio 2022）

在VS Code扩展中搜索xmake，点击安装

安装后在底部状态栏platform选择**windows**，architecture选择**x64**，mode先择**debug**

点击Build即可构建项目，确认项目能够成功构建后，按下组合键"ctrl+shift+p"，输入"xmake"，在自动补全中选择"xmake: UpdateIntellisense"，确认.vscode目录下生成了"compile_commands.json"文件

## clangd扩展安装配置

### **Step 1**

在VS Code扩展中搜索C/C++ Extension Pack，点击安装

在VS code工作区设置（按ctrl+,打开，点击工作区）中搜索"c_cpp engine"，将"C_Cpp Intelli Engine"配置为
```
disabled
```
![](docs/c_cpp_config.png)
### **Step 2**

在VS Code扩展中搜索clangd，点击安装

在VS code工作区设置（按ctrl+,打开，点击工作区）中搜索clangd，将Clangd:Arguments配置为

```
--compile-commands-dir=${workspaceFolder}/.vscode
```
![](docs/clangd_config.png)
将Clangd:Path配置为
```
${workspaceFolder}/tools/clangd.exe
```
![](docs/clangd_config2.png)
按下组合键"ctrl+shift+p"，输入"clangd"，在自动补全中选择"clangd: Restart language server"运行，底部状态栏中显示"clangd:idle"表示工作正常

## 安装C++ TestMate

在VS Code扩展中搜索C++ TestMate，点击安装，无需配置

安装后即可在测试菜单中运行单元测试

## （可选）安装todo tree

在VS Code扩展中搜索todo tree，点击安装

## （可选）安装Doxygen Documentation Generator

在VS Code扩展中搜索Doxygen Documentation Generator，点击安装

安装后输入"/**"后回车，即可自动创建doxygen注释


## vscode 插件清单
ms-vscode.cpptools-extension-pack

matepek.vscode-catch2-test-adapter

llvm-vs-code-extensions.vscode-clangd

cschlosser.doxdocgen

eamodio.gitlens

Gruntfuggly.todo-tree

tboox.xmake-vscode