这篇文章给大家分享的是有关关闭python文档字符串的方法的内容。小编觉得挺实用的，因此分享给大家做个参考。一起跟随小编过来看看吧。

创新互联公司专注为客户提供全方位的互联网综合服务，包含不限于网站设计制作、网站建设、白碱滩网络推广、重庆小程序开发、白碱滩网络营销、白碱滩企业策划、白碱滩品牌公关、搜索引擎seo、人物专访、企业宣传片、企业代运营等，从售前售中售后，我们都将竭诚为您服务，您的肯定，是我们最大的嘉奖；创新互联公司为所有大学生创业者提供白碱滩建站搭建服务，24小时服务热线：028-86922220，官方网址：www.cdcxhl.com

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

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

输出：

$ python func_doc.py
5 is maximum
Prints the maximum of two numbers.
    The two values must be integers.

它如何工作的

在函数的第一个逻辑行的字符串是这个函数的文档字符串 。

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

你可以使用__doc__（注意双下划线）调用printMax函数的文档字符串属性（属于函数的名称）。请记住Python把每一样东西都作为对象，包括这个函数。

如果你已经在Python中使用过help()，那么你已经看到过DocStings的使用了！它所做的只是抓取函数的__doc__属性，然后整洁地展示给你。你可以对上面这个函数尝试一下——只是在你的程序中包括help(printMax)。记住按q退出help。

自动化工具也可以以同样的方式从你的程序中提取文档。因此，我强烈建议你对你所写的任何正式函数编写文档字符串。随你的Python发行版附带的pydoc命令，与help()类似地使用DocStrings。

感谢各位的阅读！关于关闭python文档字符串的方法就分享到这里了，希望以上内容可以对大家有一定的帮助，让大家可以学到更多知识。如果觉得文章不错，可以把它分享出去让更多的人看到吧！

网站标题：关闭python文档字符串的方法
转载来源：http://scyanting.com/article/jeidij.html