如何在不编辑代码的情况下查看 function/class 文档字符串

Question

带有函数文档字符串的弹出窗口 window 在 Sublime Anaconda 包中非常有用，但它仅在我键入函数或右键单击 -> Anaconda -> 显示文档时显示。

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

有没有我缺少的快捷方式？我希望有一个可以查看弹出窗口 window.

Answer 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, and that documentation has a section for 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 个源文件中触发。

如何在不编辑代码的情况下查看 function/class 文档字符串

How to view function/class docstring without editing the code

python

docstring

sublimetext3