在 VS Code 中显示完整文档

问题描述 投票:0回答:7

Jupyter Notebook 显示了关于 Shift +Tab 的完整文档。有没有办法可以通过 VS Code 获得相同的效果?

Ctrl+Shift+Space 只显示方法签名,但没有相关API文档。


编辑

我希望看到的是这样的:

enter image description here

python visual-studio-code
7个回答
26
投票

刚刚开始使用 Docs View 扩展,非常棒!
https://marketplace.visualstudio.com/items?itemName=bierner.docs-view

它将您通常在悬停时看到的文档放在侧面板中。 (我是从这个tweet了解到的)

enter image description here enter image description here

也适用于笔记本视图! enter image description here


16
投票

我也有同样的问题。我发现的唯一解决方案是使用“?”在函数末尾,

np.random.randint?
奔跑

enter image description here


4
投票

我最近也尝试将 VSCode 与 Jupyter Notebooks 一起使用,对我来说(在 macOS 上,我认为 Windows 上也是一样的)我所要做的就是将鼠标悬停在我想要的方法上文档并稍等一下,它就会弹出。

请看下面的图片(因为这是我的第一个答案,所以我无法嵌入图片,但您应该可以单击链接查看)。

VSCode documentation popup


3
投票

您可以尝试使用扩展程序:

Pylance

如果要查看相关信息,可以在创建的虚拟环境中需要安装的模块下的文件夹中找到。

例如,使用模块'

pandas
',您可以在'
parsers.py
'中找到文件'
.venv\Lib\site-packages\pandas\io
',其中包含相关解析的内容。

enter image description here

参考:https://marketplace.visualstudio.com/items?itemName=ms-python.python


1
投票

正如 Caner Erden 指出的,您可以使用 Python 的基本功能来键入“?”,只需确保在方法之前而不是之后进行操作即可。

这将为您提供您正在寻找的完整文档,就在代码单元格内,不幸的是不是像 Jupyter Notebook 那样弹出窗口。

vscode-jupyter 中的文档示例

此上下文帮助问题正在 vscode-jupyter GitHub 上的此处进行跟踪。


1
投票

有时我无法读懂所有的台词;所以我单击该方法,然后将 f12 打开定义移到一侧。 然后,如果我将鼠标悬停,我可以阅读所有行。


1
投票

您可以尝试Jupyter PowerToys扩展中的

上下文帮助
功能,这是由Microsoft编写的实验性扩展:

https://marketplace.visualstudio.com/items?itemName=ms-toolsai.vscode-jupyter-powertoys

enter image description here

来自 github 上的这个线程: https://github.com/microsoft/vscode-jupyter/issues/1307

© www.soinside.com 2019 - 2024. All rights reserved.