如何在 Python 中为函数添加上下文注释
How to add context comments to functions in Pythons
我试过在网上搜索这个，但是因为我不知道它们的实际术语，所以我很难找到任何有用的东西。
如果我要用一组函数创建我自己的库，我该怎么做才能在单独的脚本中使用这些函数时，出现类似于下面黄色框的内容，提供额外的上下文和信息。
我知道默认情况下这个黄色框会显示特定功能所需的参数，但是在过去我看到这些框包含额外的附加信息和关于参数的注释，这些参数不可能由IDE，那么我该如何将这些信息添加到我的函数中，这些注释的正确名称是什么？
非常感谢任何帮助。
通常你可以通过在你的函数中定义你的参数来做这样的事情，你可以通过类型提示来改进它。您还可以在函数的开头使用 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)
我试过在网上搜索这个，但是因为我不知道它们的实际术语，所以我很难找到任何有用的东西。
如果我要用一组函数创建我自己的库，我该怎么做才能在单独的脚本中使用这些函数时，出现类似于下面黄色框的内容，提供额外的上下文和信息。
我知道默认情况下这个黄色框会显示特定功能所需的参数，但是在过去我看到这些框包含额外的附加信息和关于参数的注释，这些参数不可能由IDE，那么我该如何将这些信息添加到我的函数中，这些注释的正确名称是什么？ 非常感谢任何帮助。
通常你可以通过在你的函数中定义你的参数来做这样的事情，你可以通过类型提示来改进它。您还可以在函数的开头使用 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)