Warning: file_get_contents(/data/phpspider/zhask/data//catemap/8/python-3.x/15.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181

Warning: file_get_contents(/data/phpspider/zhask/data//catemap/0/react-native/7.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
如何向python中的函数添加上下文注释_Python_Python 3.x_Function_Comments - Fatal编程技术网

如何向python中的函数添加上下文注释

如何向python中的函数添加上下文注释,python,python-3.x,function,comments,Python,Python 3.x,Function,Comments,我试着在网上搜索这个,但是因为我不知道它们的实际名称,我很难找到任何有用的东西。 如果我要用一组函数创建自己的库,我该如何使它在单独的脚本中使用这些函数时,出现类似于下面的黄色框的内容,提供额外的上下文和信息。 我知道,默认情况下,这个黄色框将显示特定函数所需的参数,但是在过去,我看到这些框包含额外添加的信息和有关参数的注释,这些信息不可能由IDE自动添加,那么我如何将这些信息添加到我的函数中呢,这些评论的正确名称是什么? 非常感谢您的帮助。通常,您可以通过在函数中定义参数来执行类似操作,您可

我试着在网上搜索这个,但是因为我不知道它们的实际名称,我很难找到任何有用的东西。 如果我要用一组函数创建自己的库,我该如何使它在单独的脚本中使用这些函数时,出现类似于下面的黄色框的内容,提供额外的上下文和信息。

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

通常,您可以通过在函数中定义参数来执行类似操作,您可以通过类型提示来改进这一点。您还可以在函数的开头使用DOCstring来提供信息。但是,其中一些可能取决于您使用的IDE。示例代码

def my_func(param1:str,param2:int,some_flag=True)->无:
“”“这是一个使用IDE工具提示和提示的简单功能”“”
一无所获
my_func(“测试”,1)


这是否回答了您的问题?