VSCode
Author: kuzen, Natsu-Akatsuki
配置文档
配置文档
setting.json
触发保存时格式化
"editor.formatOnSave": true
插件
格式化
一般采用Ctrl+Shift+I进行触发
shell-format
cmake-format
使用时需要下载cmake_
pip3 install cmake_format
xml tools
bash, dockerfile, ignore
c/c++
括号高亮
备注
vscode 1.6版已经内置了括号高亮功能 ，在配置文档添加 "editor.bracketPairColorization.enabled": true 即可
代码块
snippetsmanager：代码块管理，更优化的可视化界面查看代码块
c/c++ snippets
代码运行快捷键
代码补全
如果用了gihub copilot的话，则可以不用下面的补全
Tabnine
使用该插件前需要安装kite engine
bash -c "$(wget -q -O - https://linux.kite.com/dls/linux/current)"
systemctl --user start kite-autostart
查看API文档
对应的默认快捷键： ctrl+h , ctrl+alt+h
生成doxygen文档
使用 /** 和回车键进行触发
使用文件模板
快速编译和运行代码
设置编译项
DEBUG
cppcheck, flawfinder, clang, flexelint...
cppcheck
sudo apt install cppcheck
flawfinder
sudo pip3 install flawfinder
markdown插件
提示
官方教程包括了： preview , outline , code snippet
表格美化
格式化
等价于typora的超链接功能
markdown lint(markdown文档规范化)
// 配置文档示例
"markdownlint.config": {
"MD013": {
"code_blocks": false
},
"MD014": false,
"MD033": false,
"line-length": false,
"no-inline-html": {
"allowed_elements": [
]
}
}
其他
markdown math：给vscode中markdown添加数学支持（latex）
remote ssh：远程连接
ros：添加ros支持
printcode：代码打印
Code Spell Checker：拼写检查与修正
Live Share: 实时协作写代码（微软官方插件）
Live Share Audio：为Live Share开启语音交流（微软官方插件）
meld diff：文本比对（支持粘贴版）
实战
配置文档
本部分介绍vscode涉及的配置文档
tasks.json：告诉编译器怎么构建程序launch.json：告诉GDB怎么启动Debug
全局配置
同步配置信息（配置文档、插件）
构建插件组(expansion pack)
步骤一：安装高版本的node.js（用apt安装的有如下警告和报错）
提示
安装时不用像官网一样导入到系统路径
步骤二：安装 Yeoman generator
npm install -g yo generator-code
步骤三：构建一个 expansion pack 文件夹
步骤四：安装 vsce 和在该文件夹下构建拓展插件
npm install -g vsce
vsce报错缺什么，package.json就加哪个字段的信息
vsce package
提示
上述命令行执行时并非一步到位，此处省略了根据提示而进行操作的步骤；其中要vsce package构建成功需要合适的package.json文件；更多可参考 [github实例](https://github.com/robertoachar/vscode-extension-pack)
自定义Button来触发pandoc
pandoc
提示
正如[此处](https://github.com/miyakogi/m2r)所述，在实际的测试中，pandoc对markdown->rst的转换效果一般，如容易丢失图片，不建议用pandoc进行转换
安装
wget -c https://github.com/jgm/pandoc/releases/download/2.14.2/pandoc-2.14.2-linux-amd64.tar.gz -O ~/application/pandoc-2.14.2-linux-amd64.tar.gz
cd application && tar -xzvf pandoc-2.14.2-linux-amd64.tar.gz
cd pandoc-2.14.2
sudo ln -s $(pwd)/bin/pandoc /usr/local/bin
sudo ln -s $(pwd)/share/man/man1/pandoc.1.gz /usr/share/man/man1
添加自动补全
echo 'eval "$(pandoc --bash-completion)"' >> ~/.bashrc
NOTE
pandoc常用选项：
配置配置文件
"actionButtons": {
"defaultColor": "#ff0034", // Can also use string color names.
"loadNpmCommands": false, // Disables automatic generation of actions for npm commands.
"reloadButton": "♻️", // 触发配置生效
"commands": [
{
"cwd": "${workspaceFolder}", // cd workspace
"name": "pandoc", // terminal name/ tip name
"color": "green",
"singleInstance": true,
"command": "pandoc -s -f markdown -t rst ${file} >> ${fileDirname}/${fileBasenameNoExtension}.rst", // This is executed in the terminal.
}
]
},
web端查看github代码
将 .com 改为 .dev
设置滚轮速度
设置自动格式化
取消标签页的重用（取消preview模式）
根据代码长度调整显示
View->Word Wrap (Alt+Z)
代码块设置
由ctrl+space触发
设置"editor.tabCompletion": "on"后可以按Tab触发snippet的插入
语法：占位符
备注
其中的option如g
latex中给选定的文本添加颜色
${color|red,green,blue}
\textcolor{blue}{...} -> \\textcolor\{blue\}{...}
\textcolor{.*}{(.*)} -> \\textcolor\{.*\}\{(.*)\}
${TM_SELECTED_TEXT/\\textcolor\{.*\}\{(.*)\}/{$1}}
|one,two,three|}
转义分为两部分：body内的，一个是正则内部的
DEBUG
sudo apt install gnome-keyring