DocStrings文档字符串是一个重要工具,用于解释文档程序,帮助你的程序文档更加简单易懂。
我们可以在函数体的第一行使用一对三个单引号'''或者一对三个双引号"""来定义文档字符串。
你可以使用__doc__(注意双下划线)调用函数中的文档字符串属性。
- #!/usr/bin/python
- # -*- coding: UTF-8 -*-
-
- def function():
- ''' say something here!
- '''
- pass
-
- print (function.__doc__) # 调用 doc
输出结果为:
- say something here!
-
DocStrings文档字符串使用惯例:它的首行简述函数功能,第二行空行,第三行为函数的具体描述。
- #!/usr/bin/python
- # -*- coding: UTF-8 -*-
-
- def printMax(x,y):
- '''打印两个数中的最大值。
-
- 两个值必须都是在整形数。'''
- x=int(x)
- y=int(y)
- if x>y:
- print(x,'最大')
- else:
- print(y,'最大')
-
- printMax(3,5)
- print (printMax.__doc__) # 调用 doc
输出结果为:
- 5 最大
- 打印两个数中的最大值。
-
- 两个值必须都是在整形数。