如何在 Python 中向函数添加上下文注释 [重复]答案

【问题标题】：How to add context comments to functions in Pythons [duplicate]如何在 Python 中向函数添加上下文注释 [重复]
【发布时间】：2020-11-02 13:59:52
【问题描述】：

我试过在网上搜索这个，但由于我不知道它们的实际术语，我很难找到任何有用的东西。如果我要使用一组函数创建自己的库，我该如何制作，以便当我在单独的脚本中使用这些函数时，会出现类似于下面黄色框的内容，提供额外的上下文和信息。

我知道默认情况下，这个黄色框会显示特定功能所需的参数，但是在过去我看到这些框包含额外的附加信息和有关参数的 cmets，这些参数不可能只是由 IDE 自动添加，那么如何将这些信息添加到我的函数中，这些 cmets 的正确名称是什么？非常感谢任何帮助。

【问题讨论】：

这能回答你的问题吗？ How to document a method with parameter(s)?

标签： python python-3.x function comments

【解决方案1】：

通常你可以通过在你的函数中定义你的参数来做这样的事情，你可以通过类型提示来改进它。您还可以在函数开头使用 DOCstring 来提供信息。但是，其中一些可能取决于您使用的 IDE。示例代码

def my_func(param1: str, param2: int, some_flag=True) -> None:
    """This is a simple function to utilise IDE tooltips and hints"""
    return None


my_func("test", 1)

【讨论】：