DocStrings

Python???????????????????? ???????? ????????????? docstrings ??DocStrings???????????????????????????????????????????????t????????????????????????????е??????????????????????

???DocStrings

??7.8 ???DocStrings

#!/usr/bin/python
# Filename: func_doc.py

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__

????????code/func_doc.py??

???

$ python func_doc.py
5 is maximum
Prints the maximum of two numbers.

        The two values must be integers.

????ι???

???????????????е????????????????? ???????? ?????DocStrings?????????????????????????????????????????

????????????????????????????????????????д????????????β???????????У???????п??????????????? ?????? ????????????????????????????????????

????????__doc__????????????????printMax???????????????????????????????????????Python?? ???????? ???????????????????????????????????????????????????????

??????????Python????ù?help()????????????????DocStings???????????????????????????__doc__??????????????????????????????????????????????????????????а???help(printMax)???????q???help??

??????????????????????????????????????????????? ?????? ???????д???κ??????????д???????????????Python???а渽????pydoc??????help()????????DocStrings??