在PyDev中显示函数文档

Question

我已经把Pydev安装好了，基本上都能正常使用。不过，我在使用文档字符串（docstrings）时遇到了一些问题。

比如说，我有一个这样的函数：

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的缺陷追踪系统上提交了一个功能请求，编号是863。

在PyCharm中，当我把鼠标悬停在一个方法名上时，会弹出一个窗口，里面只显示每个方法的文档字符串，而不包含具体的实现细节。而且，像@param xx:、@rtype这些标签会被正确解析，并以易读的格式显示在弹出窗口中。不同的样式，比如spinx、epytext、google、plain等，可以在设置中调整，以便它能识别所有格式。

我想在PyDev中也建议添加类似的功能：一个弹出窗口，显示解析后的文档字符串和标签，而不包含实现细节。如果像javadoc那样，可以使用<code>一些代码</code>来像HTML一样渲染，这样会更好。

如果你也想要这个功能，可以考虑给这个请求投票支持。（也可以在这里投票支持一下）

Answer 2

现在看起来并不是这样。我在网上查了一下这个问题，找到的第一个结果指向了这个Pydev-users的帖子：

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

你好，

当我把鼠标悬停在一个函数或类上时，弹出的提示框显示的是整个函数或类的定义，而不仅仅是文档字符串（我本来期待的是这样）。

这是正常的行为吗？我觉得如果只显示文档字符串的内容会更有用。

现在这是正常的。请提交一个功能请求，让只显示文档字符串成为一个选项。

谢谢，

Fabio

我在Pydev的错误/功能跟踪器里找了找，没有找到这个具体的问题。你可能想在Pydev的功能请求跟踪器里提交这个问题，看看能否得到帮助。