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

Question

我正在尝试添加帮助文本以在我的 python 脚本中运行，类似于为 input() 或 print() 打开括号时的情况。 Docstrings 做类似的事情，但在编写代码时没有用。

我想要的请看下图。用于打印的黄色弹出文本是我也想为 pythagorus() 函数或类似的东西出现的内容。

我也希望能把它应用到除此以外的功能上

Answer 1

看起来您正在使用空闲模式。您看到的黄色弹出窗口实际上是 print 文档字符串的第一行。通常 idle 显示方法签名（除了像 print 这样的内置函数）和文档字符串的第一行，所以如果你想在那里显示一些有用的东西，然后使用有用的文档字符串。

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

如果您的示例函数采用两个参数并且 return 一个值，那么它实际上会更有意义。那么它可能看起来像这样：

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

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

空闲时会这样显示：

Adding help text for Python module in Docstring