文档字符串Doc String

  doc string:文档字符串。它是一个重要的工具，帮助你的程序文档更加简单易懂，应该尽量使用它。甚至可以在程序运行时候，从函数恢复文档字符串。

  在函数的第一个逻辑行的字符串是这个函数的文档字符串。注意:Doc String也适用于模块和类。

  文档字符串的惯例是一个多行字符串，它的首行以大写字母开始，句号结尾。第二行空行，从第三行开始是详细的描述。强烈建议遵循这个惯例。

例:

def printMax(x，y):

    """ Print the maximum of two numbers.

   

        The two values must be integers. """

    x = int(x)

    y = int(y)

    if x > y:

        print(x," is maximum")

    else:

        print(y," is maximum")

printMax(3,5)  #打印出:5 is maximum.

printMax(_doc_)  # 打印出:Print.... integer.

注:

使用_doc_(注意是两个下划线)调用printMax()函数的文档字符串属性。请记住python把每一样东西都作为对象，包括这个函数。

python中help()函数即是使用doc string的，它只是抓取函数的_doc_属性，然后整洁的展现，可以对上面的函数尝试一下:help(printMax)。按q退出。