在 PyDev 中显示函数文档

Question

我已经启动并运行了 Pydev，几乎一切都运行良好。但是我在文档字符串方面遇到了一些麻烦。

假设我有一个如下所示的函数：

def _get_logging_statement(self):
    """Returns an easy to read string which separates items in the log file cleanly"""
    result = "\n\n#============================================="
    result += "\n#   %-80s#"(self)
    result =+ "\n\n#============================================"
    return result

假设我已经重写了 repr 以正确格式化该字符串。

当我将鼠标悬停在 Eclipse 中时，它会按预期显示完整的文档字符串。然而，完整的实现也显示在文档下方。

有没有办法仅显示文档字符串？

Answer 1

目前看起来不像。谷歌搜索这个问题，最上面的结果向我指出了这个 Pydev 用户帖子：

<块引用>
<块引用>

2010 年 5 月 3 日星期一上午 5:45，Janosch Peters 写道：

嗨，

当我将鼠标悬停在函数或类上时，我会收到一个工具提示，显示
函数/类的整个定义不仅仅是文档字符串（正如我
会期望）。

这是预期的行为吗？我认为这会更有用，如果只是
显示文档字符串的内容。

目前预计。请输入要提出的功能请求
仅显示文档字符串选项。

干杯，

法比奥

查看了 Pydev 错误/功能跟踪器，没有发现输入的这个特定问题。您可能想将其输入 Pydev 功能请求跟踪器中，看看是否可以在那里获得帮助。

Answer 2

我已在 PyDev bug tracker 中提交了功能请求，ID 为 863。

在 PyCharm 中，当我将鼠标悬停在方法名称上时，我可以看到一个弹出窗口显示
只有每个方法的文档字符串，没有实现细节。
并且，诸如 @param xx:、@rtype 等标签都被正确解析
并在弹出窗口中以可读格式显示，以及不同的样式，例如
spinx/epytext/google/plain 可以在设置中进行调整，以便它可以
识别所有格式。

我想在 PyDev 中提出同样的建议：一个弹出窗口显示
带有已解析标签的文档字符串，没有实现细节，并且 if
与 javadoc 一样，可以使用 some code 来像 HTML 一样呈现它，效果更好。

如果您也想要此票，请考虑投票支持此票。 （也许也在这里投票）