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上时，它会向我显示完整的文档字符串。但是，完整的实现也会显示在doctsting下面。

有没有办法只显示docstring？

Answer 1

目前看起来不像。谷歌搜索这个问题，最高结果指向我Pydev-users post：

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

您好，

当我将鼠标悬停在一个函数或类上时，我会得到一个显示该函数的工具提示       函数/类的完整定义不仅仅是docstring（就像我一样）       会期待的。）

这是预期的行为吗？我认为如果只是这样会更有用       显示docstring的内容。



目前预计。请输入要求的功能   只显示docstring一个选项。

干杯，

的Fabio

查看Pydev错误/功能跟踪器，但未发现输入此特定问题。您可能希望在Pydev功能请求跟踪器中输入它，看看是否可以在那里获得帮助。

Answer 2

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

在PyCharm中，当我将鼠标悬停在方法名称上时，我可以看到弹出窗口显示   只有每个方法的docstring，没有实现细节。   并且，正确解析@param xx:，@rtype等标记   并以弹出的可读格式显示，和不同的风格一样   spinx / epytext / google / plain可以在设置中调整，以便它可以   识别所有格式。

我想在PyDev中提出同样的建议：一个显示的弹出窗口   解析了标签的docstring，没有实现细节，如果   像javadoc一样，可以使用<code>some code</code>来渲染它，就像在HTML中一样，更好。

如果您也想要这个，请考虑对此票证进行投票。（也许也可以在这里投票）

在PyDev中显示函数文档

2 个答案: