8、Python 函数与模块的深入解析

Python 函数与模块的深入解析

1. 函数文档字符串（DocStrings）

1.1 什么是 DocStrings

Python 有一个很棒的特性叫做文档字符串（DocStrings），它能帮助我们更好地记录程序，让程序更易于理解。而且，在程序运行时，我们甚至可以从函数中获取其文档字符串。

1.2 示例代码

# ! / u s r / b i n / p y t h o n
#  F i l e n a m e :  f u n c _ d o c . p y
def printMax(x, y):
    ''' Prints the maximum of two numbers.
    The two values must be integers. '''
    x = int(x)  # convert to integers, if possible
    y = int(y)
    if x > y:
        print(x, 'is maximum')
    else:
        print(y, 'is maximum')

printMax(3, 5)
print(printMax.__doc__)

1.3 输出结果

$  p y t h o n  f u n c _ d o c . p y
5  i s  m a x i m u m
Prints the maximum of two numbers.