python 函数文档

Posted 2021-11-29 lws865

1.使用help函数(推荐使用)

1 #使用help函数(推荐使用)
2 help(id)
3 help(print)
4 help(type)
5 #上面查看函数的用法，可以复制到翻译软件查看用法

 

2.函数名.__doc__

1 #函数名.__doc__
2 print(id.__doc__)
3 print(print.__doc__)
4 #上面查看函数的用法，可以复制到翻译软件查看用法

 

3.自定义函数的文档

 1 #自定函数
 2 def getsum(no1,no2):
 3     ‘‘‘
 4     :功能:  计算两个数值的和
 5     :参数1  no1: Number类型
 6     :参数2  no2: Number类型
 7     :返回值 : 两个数值的和 Number
 8    ‘‘‘
 9     result = no1 + no2
10     return result
11 
12 #查看自定义函数的文档
13 help(getsum)