在PYDEV中显示功能文档

StackOverflow https://stackoverflow.com/questions/4451645

题

我已经开始运行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

假设我也正确地覆盖了该字符串的格式。

当我在Eclipse中徘徊时，它向我展示了预期的完整docstring。但是，完整的实施也显示在医生下方。

有办法 只要 显示docstring？

有帮助吗？

解决方案

目前看起来不像它。谷歌搜索了这个问题，最重要的结果向我指出了这一点 Pydev-users帖子:

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

你好，

当我徘徊在函数或类上时，我会得到一个工具提示，不仅显示了功能/类的整个定义（如我所期望的）。

这是预期的行为吗？我认为，如果仅显示docstring的内容，这将更有用。

目前预计。请输入功能请求，以使仅显示Docstring一个选项。

干杯，

法比奥

围绕PYDEV错误/功能跟踪器查看，但没有发现输入此特定问题。您可能需要在PYDEV功能请求跟踪器中输入它，并查看是否可以在那里获得帮助。

其他提示

我已经在 PYDEV错误跟踪器, ，ID 863。

在Pycharm中，当我悬停在方法名称上时，我可以看到一个弹出窗口仅显示每个方法的docstring，而无需实现详细信息。而且，标签喜欢 @param xx:, @rtype, 等等，正确解析并在弹出窗口中以可读格式显示，并且可以在设置中调整Spinx/Epytext/Google/Plain（例如Spinx/Epytext/google/plain）的不同样式，以便它可以识别所有格式。

我想在PYDEV中建议使用相同的内容：一个弹出窗口，显示带有标签的docstring，而没有实现详细信息，如果像Javadoc一样，可以使用 <code>some code</code> 像在html中一样呈现它，更好。

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

许可以下： CC-BY-SA 和 归因
不隶属于 StackOverflow
scroll top