python第九篇之-函数帮助信息(doc)

#!/usr/bin/python

def printMax(x,y):
    '''Prints the maximum of two numbers.

    The two values must be integers'''
    x = int(x)
    y = int(y)
    
    if x > y:
        print(x,'is the maximum')
    else:
        print(y,'is the maximum')

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

其中在函数开头定义的那段字符串就是函数的信息：

help的结果：

Help on function printMax in module __main__:

printMax(x, y)
    Prints the maximum of two numbers.
    
    The two values must be integers
(END)

print(printMax.__doc__)输出：

Prints the maximum of two numbers.

    The two values must be integers

函数的输出：

5 is the maximum

利用这个功能可以打印函数的帮助信息，来帮助自己进行开发，也可以给自己的函数写一些帮助信息。