如何在VSCode中预览Python docstring,实现Jupyter shift+tab同款效果
VSCode Python 查看原生docstring配置方法
- 先确认已安装微软官方的「Python」扩展及配套的Pylance组件
- 打开VSCode设置页:按快捷键
Ctrl + ,(Windows/Linux)或Cmd + ,(Mac) - 在设置搜索框输入
python.analysis.documentationStyle,将选项值从默认的markdown切换为plaintext,该配置会让Pylance直接输出未加工的原始docstring内容 - 确认悬停功能开启:搜索
editor.hover.enabled,确保勾选状态为开启 - (可选)自定义快捷键:如果需要和Jupyter一致的
Shift + Tab唤出效果,打开键盘快捷方式面板(快捷键Ctrl + K Ctrl + S),搜索「显示悬停」,将对应命令的快捷键修改为Shift + Tab即可
配置完成后,光标停留在目标方法上,或按下自定义快捷键,弹出的文档内容就和print(方法名.__doc__)的输出完全一致,和Jupyter的预览效果相同。
内容的提问来源于stack exchange,提问作者bjarkemoensted
相关产品推荐
相关产品推荐

