【问题标题】:Show complete documentation in vscode在 vscode 中显示完整的文档
【发布时间】:2020-07-31 23:14:09
【问题描述】:

Jupyter Notebook 在 shift + tab 上显示了完整的文档。 有没有办法让我用 vscode 得到同样的结果?

Ctrl + shift + space 只提供方法签名。

编辑:我希望看到这样的东西

【问题讨论】:

  • CTRL + SPACE 是否符合您的预期?
  • @soulshined,不。 Ctrl + space 只显示建议。
  • 它应该显示建议和详细信息(这是 vscode 中的一种文档形式),如果您对给定方法没有建议,我不确定
  • 不完全确定这是否是您正在寻找的。但我是 Python 扩展的开发人员。我们在这里的积压工作中有这个问题:github.com/microsoft/vscode-python/issues/7850 可能想要投票,因为这就是我们如何看待下一步工作的方式。
  • @IanHuff,我意识到Ctrl+Shift+Enter 显示了有关某些方法(如pd.read_pickle)和一些不(如pd.read_csv)的完整文档。您提供的链接确实回答了这个问题。如果您可以将其作为答案,我可以接受并关闭此问题。

标签: python visual-studio-code


【解决方案1】:

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

np.random.randint?运行

【讨论】:

  • 我认为应该选择这个作为答案,因为不幸的是没有找到其他解决方案!
【解决方案2】:

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

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

【讨论】:

    【解决方案3】:

    您可以尝试使用扩展名:Pylance

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

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

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

    【讨论】:

      【解决方案4】:

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

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

      也可以在笔记本视图中使用!

      【讨论】:

        【解决方案5】:

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

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

        Example of documentation in vscode-jupyter

        正在 vscode-jupyter GitHub 上 here 跟踪此上下文帮助问题。

        【讨论】:

          【解决方案6】:

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

          【讨论】:

            猜你喜欢
            • 2012-12-28
            • 2021-07-04
            • 2022-11-22
            • 1970-01-01
            • 1970-01-01
            • 1970-01-01
            • 2020-09-15
            • 1970-01-01
            • 1970-01-01
            相关资源
            最近更新 更多