在 PyDev 中显示函数文档答案

【问题标题】：Displaying function documentation in PyDev在 PyDev 中显示函数文档
【发布时间】：2011-05-25 23:56:37
【问题描述】：

我已经启动并运行了 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 中将鼠标悬停在它上面时，它会按预期显示完整的文档字符串。但是，完整的实现也显示在 doctsting 下方。

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

【问题讨论】：

注意：我不希望将文档字符串放在实现下面，因为这似乎违反了 PEP 标准。
双下划线方法令人不快（它们会导致函数名称被破坏，从而导致错误并且没有提供额外的安全性）——使用后果自负！
从 katrielalex 开始，以单个下划线开头可以避免麻烦，并且按照惯例仍被视为“内部”。
@katrielalex 修改了每个评论的函数定义。较新的python，所以感谢您的注意。
看起来pydev总是在方法下显示整个主体。不确定是否有设置可以更改。

标签： python eclipse pydev code-hinting

【解决方案1】：

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

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

嗨，

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

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

目前是预期的。请输入要进行的功能请求仅显示文档字符串一个选项。

干杯，

法比奥

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

【讨论】：

【解决方案2】：

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

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

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

如果您也想要这张票，请考虑投票给这张票。（也许也可以在这里投票）

【讨论】：