【问题标题】:How to view function/class docstring without editing the code如何在不编辑代码的情况下查看函数/类文档字符串
【发布时间】:2019-09-05 14:41:53
【问题描述】:

带有函数文档字符串的弹出窗口在 Sublime Anaconda 包中非常有用,但是只有当我键入函数或右键单击 -> Anaconda -> 显示文档时才会显示。

在阅读别人的代码时,我想查找什么是函数文档字符串,而无需右键单击或使用诸如删除和重新键入函数的最后一个字符之类的解决方法。

我缺少快捷方式吗?我预计会有一个可以查看弹出窗口。

【问题讨论】:

  • FWIW PyCharm 具有“快速文档”快捷方式,如果已配置,则可以做到这一点。你可以在 sublimetext 的设置中搜索类似的快捷方式
  • 或者,如果您处于使用 Python 控制台(例如 shell)的更简单环境中,您也可以 help(func)。但是 PyCharm 更好!

标签: python sublimetext3 docstring


【解决方案1】:

一般来说,如果您可以通过从菜单中选择一个项目来触发一个动作,您也可以将一个键绑定到它(反之亦然)。

为此,您可以使用 Ctrl+`View > Show Console 打开 Sublime 控制台,然后输入命令 sublime.log_commands(True) 以打开命令日志记录。完成后,执行命令(在本例中通过从上下文菜单中选择项目)并查看控制台中记录的内容。

对于这个命令,输出是这样的:

command: anaconda_doc {"event": {"x": 344.5, "y": 644.5}}

这表示正在执行的命令是anaconda_doc;参数是您发出命令时鼠标所在的位置。

有了这个,您可以使用Preferences > Key Bindings 并将一个键绑定到命令anaconda_doc 以通过快捷键触发相同的命令。

也就是说,包的文档是从它的Package Control page 链接的,并且该文档有一个how to view doc strings 部分概述了触发它的方法,其中包括一个默认键绑定:

当一个包有它自己的默认键绑定时,它们通常在它的首选项菜单部分中可见,在这种情况下为Preferences > Package Settings > Anaconda > Key Bindings - Default;选择该选项将向您显示绑定的定义方式,以便您可以更改它(通过将其复制到您的用户设置并更改密钥):

    {
        "command": "anaconda_doc", "keys": ["ctrl+alt+d"], "context": [
            {"key": "selector", "operator": "equal", "operand": "source.python"}
        ]
    },

默认绑定确保它只在 Python 源文件中触发。

【讨论】:

  • 非常感谢!这就是我一直在寻找的。​​span>
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 2016-04-09
  • 2019-04-07
  • 1970-01-01
  • 1970-01-01
  • 2017-06-09
  • 1970-01-01
  • 2018-08-30
相关资源
最近更新 更多