Vscode
1.显示参数名,在设置里搜 Inlay Hint¶
总体设置
1 |
|
1.1 针对C++¶
然后找到C++和pylance的启动项
1.2 针对python¶
目前针对python(pylance)还实现不了这样的功能,需要借助另外一个插件 Inline Parameters for VSCode
2 C++插件设置¶
2.1安装插件以及简单设置¶
下载C/C++ Extension Pack:
c/c++ 提供代码跳转,主要配置如下:
提示与高亮相关: Compile Commands:设置为cmake生成的compile_commands.json Cpp Standard:设置为C++17 Configuration Provider:"ms-vscode.cmake-tools" Intelli Sense Mode:windows-gcc-x64
格式化相关: Clang_format_fallback Style:Google Clang_format_path:C:/Program Files (x86)/LLVM/bin/clang-format.exe Clang_format_style:file
cmake 提供cmake的代码提示和语法高亮
cmake tools 提供cmake编译,配置如下: Export Compile Commands File:true
2.2通过Configuration Provider配置include提示(与2.3选一个)¶
CMake Tools插件能够给C/C++插件提供信息,实现IntelliSense、代码补全、注释浏览、文件转跳等功能。一般在第一次使用CMake Tools插件时会出现如下提示:
Allow之后会在当前工作目录的.vscode/settings.json文件(即当前工作目录的设置文件,会覆盖用户设置文件)中添加:
1 2 3 |
|
当然,也可以在C/C++插件的配置文件.vscode/c_cpp_properties.json中手动指定configurationProvider:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
|
这样C/C++插件就能正常工作了,不用自己指定.vscode/c_cpp_properties.json的includePath和defines。
2.3 通过compile_commands.json配置include¶
除了以上两种方式以外,还有另一种方式:
指定compile_commands.json 让cmake生成compile_commands.json,需要在运行cmake时添加参数-DCMAKE_EXPORT_COMPILE_COMMANDS=True或者在CMakeLists.txt中添加set(CMAKE_EXPORT_COMPILE_COMMANDS True)。
例子:假设在~目录下有一个hello的项目
1 2 3 4 |
|
在vscode中打开/hello目录,配置.vscode/c_cpp_properties.json。指定compileCommands为上一步的/hello/build/compile_commands.json:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
|
cmake插件的设置¶
选择不同的cmakelist.txt文件以获得cmake tools插件的支持:
settings.json添加如下
1 |
|
3 python的初始化插件设置¶
下载python插件、pylance插件,并把pylance作为python插件的语言服务器
Pylance
强烈建议使用Pylance替代默认的Python语言服务器,它支持一些很棒的功能,比如:
- Docstrings
- 自动导入
- 类型检查
- Code Lens
- IntelliCode 兼容性
设置如下:
1 2 3 |
|
设置code formatter为black
它和默认使用的autopep8
的不同之处在于它不仅会指出代码中违反PEP8
规范的地方,还会对没有违反PEP8
但代码风格不一致的地方重新格式化,可以让令代码的可读性更强。
设置步骤:
- 打开设置(
Ctrl+ ,
):搜索"formatting.provider"
- pip install black
- 如果想在 Jupyter Notebooks 中使用,则可以通过如下代码安装:pip install black[jupyter]
- 也可以直接打开设置文件添加一行:
"python.formatting.provider": "black",
- 使用方法:选中需要格式化的代码,右键选择格式化选定内容,快捷键:
Ctrl + K, Ctrl + F
或者Alt+Shift+F
(ubuntu为Ctrl+Shift+I
)
设置自动格式化
可以打开保存时和键入一行后立即进行代码格式化,设置选项为:
1 2 3 4 |
|
自动补全设置
打开自动添加括号,在自动补全函数时,可以自动加上括号,提高效率:
1 2 3 |
|
添加自动补全库路径(设置了python.autoComplete.extraPaths就不用单独设置pylance了)
为额外的Python库支持自动补全,设置路径:
1 2 3 |
|
添加分析路径(防止找不到库,设置了python.autoComplete.extraPaths就不用单独设置pylance了)
添加额外导入路径,设置:
1 2 3 |
|
这对于导入项目中一些自己实现的python文件很有帮助。
添加垂直参考线
Python的代码风格要求代码一行不超过79字符,所以我们可以给代码编辑器设置一条垂直参考线,直观判断代码是否太长,并且可以自定义参考线的颜色:
1 2 3 4 5 6 7 8 |
|
4vscode快捷键¶
vim配置
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 |
|
vscode快捷键:keybindings.json
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
|
cmake tools: 编译并运行:shift+f5 编译并调试:ctrl+f5
python: 快速运行:ctrl+alt+n
latex: 快速编译:ctrl+shift+b
5 vscode配色¶
one dark pro配色详解:
蓝色:函数、
红色:变量
黄色:类、结构体、命名空间
紫色:关键词
深黄色:数字
绿色:text
6 VScode中的task.json和launch.json¶
1 2 |
|
快速创建launch.json:点击debug按钮,或者ctrl+shift+p搜索run and debug,在生成的launch.json的config中打一个c,选择C/C++gdb启动,就会自动生成模板。
快速创建task.json :ctrl+shift+p,搜索build task,选择配置task
对于一般的C++工程来说,f5直接会运行launch.json.
参数解释: cwd(current work directory):当前工作目录 "problemMatcher":问题分析器,对于编译后输出的结果可以提取有用的部分,不同的插件会提供一些预定义好的问题分析器,比如"/$ catkin-gcc"、"/$ roslaunch"、 "cmake"等,也可以自己用正则表达式实现。 label:可以随便取
普通Cmake工程的launch.json和task.json¶
例如对于一个cmke工程:
launch.json用来debug,主要修改"program","preLaunchTask"(要跟task.json配合),"miDebuggerPath"三个参数
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 |
|
tasks.json:用来编译,包含了三个任务,第一个任务执行cmake,第二个任务执行make,第三个任务名称是Build,执行cmake和make两个任务,将Build设置成launch.json中preLaunchTask的值,正是代表,在调试之前先执行cmake和make两个命令;
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 |
|
ROS工程的launch.json和task.json¶
launch.json:ros中launch.json可以用来启动launch节点,也可以用来debug。可以选择其中一种用法
启动launch节点的launch.json
1 2 3 4 5 6 7 8 9 10 11 12 |
|
用于调试的launch.json
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
|
7 Latex设置¶
1 安装 texlive,配置好环境变量(不需要装smartpdf)¶
window 在清华镜像下载iso:https://mirrors.tuna.tsinghua.edu.cn/#
linux在官网下载:https://tug.org/texlive/acquire-netinstall.html 下载install-tl-unx.tar.gz,解压 并且sudo ./install-tl-unx
为了能够在linux 的vscode中格式化需要安装一些包(windows不需要) sudo cpan Log::Log4perl sudo cpan Log::Dispatch sudo cpan YAML::Tiny sudo cpan File::HomeDir sudo cpan Unicode::GCString
2vscode 安装latex workshop¶
3.配置settings.json¶
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 |
|
4.¶
记得将vscode 的clean设置为glob,不然latex-workshop.latex.clean.fileTypes不生效
8 settings.json¶
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 |
|
9 高效设置¶
打开的编编辑器
多行展示tabs:wrap tabs
终端显示行数上限
10 配置远程免密码登录¶
注意:不论是远程ssh还是github、gitee,只要想在本地免密码登录ssh-server、github、gitee,就要把本地的公钥放到ssh-server、github、gitee上。
- 在本地(windows)生成sshkey: ssh-keygen -t rsa
- 在C盘用户下的.ssh文件夹下找到id_rsa.pub 公钥
- 复制公钥里的内容
- 在远程linux下生成sshkey(可选,如果之前生成就不用此步骤,此步骤主要是为了在home下生成.ssh文件夹) ssh-keygen -t rsa
- 进入到远程linux下的.ssh下创建一个文件 authorized_keys,并把3中的内容复制进去。
11 vscode配置pyproject.toml¶
如果对于mmdection中config,pyright经常标红,这是因为pylance的版本太新,解决方案: