help()函数是Python中的内置函数
通过help()函数可以查询python中函数的用法
语法:help(函数对象)
比如获取 print 的函数用法,注意是直接输入对象
help(print)
得到了print函数的详细用法
我们试一下自定义的函数,看看可不可以获取到用法
deffn(a,b,c): return10help(fn)
函数的结构显示出来了,因为在定义函数时没有写说明,所以运行出来的结果没有上面的 print 后面跟的说明,怎么加上说明呢。
文档字符串(doc str)
在定义函数时,可以在函数内部编写文档字符串,文档字符串就是函数的说明,当我们编写了文档字符串时,就可以通过help()函数来查看函数的说明
其实直接在函数的第一行写一个字符串就是文档,但是一般我们会使用三重引号,我们这个长字符串是可以跨行写,这是文档字符串的示例,可以写 函数的作用 函数的参数 ,参数 a 的作用是什么,类型是什么,默认值等等。
deffn(a:int,b:float,c:str='hello')->int: ''' 这是一个字符串 函数的作用。。。。。。 函数的参数: a:作用,类型,默认值。。。。。 b:作用,类型,默认值。。。。。 c:作用,类型,默认值。。。。。 '''return10help(fn)
我可以在 a 后面写一个:int 在 b 后面:bool 在 c 后面加入: str
这样通过它我能看出来需要什么类型,但是注意
这只是一个描述,没有其他任何作用,没有强制性。这时候在看文档字符串,能看出来什么类型了,更加清晰。
Fn(a:int, b:bool, c:str)
假如 c 有默认值,有默认值可以直接写 c:str = ‘hello’ 默认值就是 hello
也可以在后面写一个 -> str:
这表示函数的返回值是一个字符串,str 是 int,返回值就是整型