Python函数文档化字符串

在Python中有一个奇妙的特性，文档字符串，又称为DocStrings。用它可以为我们的模块，类，函数添加说明性的文字，令其容易理解。更重要的是可以通过Python自带的标准方法将这些描述性文字信息输出。下面举例说明。

def printMax(x, y):
    '''打印两个数中的最大值。    两个值必须是整数。'''
    x = int(x) # 如果可能，转换为整数
    y = int(y)

    if x > y:
        print(x, '最大')
    else:
        print(y, '最大')

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

输出：

5 最大
打印两个数中的最大值。    
两个值必须是整数。

函数的第一个逻辑行的字符串是那个函数的文档字符串。文档的以贯例是多行字符串，第一行以大写字母开头以句点(.)结束，第二行是空行，从第三行开始是详细描述。这是重要的函数写文档字符串要遵循的贯例。