在Docstring中添加Python模块的帮助文本

Question

我试图在我的python脚本中添加帮助文本，类似于为input（）或print（）打开括号时。 Docstrings做了类似的事情，但在编写代码时没用。

见下图为我想要的。用于打印的黄色弹出文本是我也想要为pythagorus（）函数或类似的东西。

我也希望将此功能应用于此以外的功能。

Answer 1

看起来你正在使用闲置。您实际看到的的黄色弹出窗口是 print文档字符串的第一行。通常空闲时显示方法签名（内置类似print）和文档字符串的第一行，所以如果你想在那里显示一些有用的东西，那么请使用有用的文档字符串。

在python3中，您还可以使用function annotations来提示正确使用您的函数。

如果它需要两个参数并返回一个值，那么你的示例函数实际上会更有意义。然后它看起来像这样：

def pythagorus(a: int, b: int) -> int:
    """ calculate a**2 + b**2

    ... usage example, etc ...
    """
    return math.sqrt(a**2 + b**2)

这样会在闲置中出现：