身为一只讲究人,写了代码想给别人用,就需要尽可能详细的说明这个函数的使用方法。
help()是Python中的内置函数
通过help()函数可以查询python中的函数的用法
语法:help(函数对象)
help(print) # 获取print()函数的使用说明
文档字符串(doc str)
在定义函数时,可以在函数内部编写文档字符串,文档字符串就是函数的说明,当我们编写了文档字符串时,就可以通过help()函数来查看函数的说明,文档字符串非常简单,其实直接在函数的第一行写一个字符串就是文档字符串。
函数+文档编写示例:
def fn(a:int,b:bool,c:str='hello') -> int:
'''
这是一个文档字符串的示例
函数的作用:。。。。。
函数的参数:
a,作用,类型,默认值。。。。
b,作用,类型,默认值。。。。
c,作用,类型,默认值。。。。
'''
return 10
help(fn)