简明 Python 教程
第7章 函数
上一页 DocStrings 下一页

DocStrings

Python有一个很奇妙的特性,称为 文档字符串 ,它通常被简称为 docstrings 。DocStrings是一个重要的工具,由于它帮助你的程序文档更加简单易懂,你应该尽量使用它。你甚至可以在程序运行的时候,从函数恢复文档字符串!

使用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。


上一页 上一级 下一页
return语句 首页 概括
时时彩计划软件公式
@ssv
时时彩五星缩水 时时彩推广网站源码 hg0088皇冠国际 时时彩平台哪里有 澳门5分时时彩官方网站
优游时时彩平台登录 厘模式的彩票平台 舞帝时时彩平台 重庆时时彩8码滚雪球 时时彩代理拉人买彩票犯法吗
vv时时彩平台代理 时时彩支付宝充值 重庆时时彩开奖记录 时时彩平台teafly 时时彩qq群号
最稳定时时彩软件 时时彩内蒙古开奖结果 时时彩精准计划手机版 时时彩分析软件手机版 u优乐娱乐官方网站