函数文档
函数文档就是用来查看当前函数相关信息介绍的一个特定格式而已。
查看函数文档的方法:
help(函数名)
此方法会直接输出函数文档的内容
函数名.__doc__
直接输出显示函数文档的内容元字符串(可以使用print(函数名.__doc__)来解决无格式问题)
定义函数文档的方法:
def 函数名(参数):
'''
这里编写函数文档
'''
这里编写函数的code...
示例:
#定义函数文档的方式
def funName(**car):
'''
这里是函数文档
本函数功能是...
要求的参数类型是...
返回的数据是...
'''
print('函数文档的定义方法')
help(funName)
#查看函数文档
'''注释:
函数文档的作用是对函数进行说明,便于阅读和快速掌握函数的使用,通常函数文档需要具有以下信息:
1.函数的作用
2.函数的参数介绍(需要几个参数,分别是什么类型)
3.函数的返回值(数据和类型)
'''
查看函数文档的方法1(推荐!)
help(id) help(type) 查看函数文档的方法2 print(id.__doc__) print(print.__doc__) 书写自己函数的文档 定义一个函数 def lashi(something): ''' :功能:展示睡觉的过程! :参数 something: 传入一个字符串~! :返回值: None ''' print('上床') print('脱衣服') print('关灯') print('躺下来') print('闭眼',something) print('睡觉') #调用函数 lashi('盖被子') #查看函数文档 help(lashi)