介绍 # !/usr/bin/python
#,文件名:func_doc.py
def printMax (x, y):
,,,& # 39;& # 39;& # 39;Prints 从而maximum of two 数字。
,,,,two values must be 整数强生# 39;& # 39;& # 39;
,,,x =, int (x), #, convert 用整数,if 可能的
,,,y =, int (y)
,,,,
,,,if x 祝辞,y:
,,,,,,,print x,, & # 39; is 最大# 39;
,,,:
,,,,,,,print y, & # 39; is 最大# 39;
printMax (3, 5)
print printMax。__doc__ ,美元python func_doc.py
5,is 最大
Prints 从而maximum of two 数字。
,,,,two values must be 整数。
这篇文章给大家分享的是有关关闭python文档字符串的方法的内容。小编觉得挺实用的,因此分享给大家做个参考。一起跟随小编过来看看吧。
python有一个很奇妙的特性,称为文档字符串,它通常被简称为文档字符串.DocStrings是一个重要的工具,由于它帮助你的程序文档更加简单易懂,你应该尽量使用它。你甚至可以在程序运行的时候,从函数恢复文档字符串!
<强>使用文档字符串
输出:
<强>它如何工作的
在函数的第一个逻辑行的字符串是这个函数的文档字符串。
文档字符串的惯例是一个多行字符串,它的首行以大写字母开始,句号结尾。第二行是空行,从第三行开始是详细的描述。强烈建议你在你的函数中使用文档字符串时遵循这个惯例。
你可以使用__doc__(注意双下划线)调用printMax函数的文档字符串属性(属于函数的名称)。请记住Python把每一样东西都作为对象,包括这个函数。
如果你已经在Python中使用过帮助(),那么你已经看到过DocStings的使用了!它所做的只是抓取函数的__doc__属性,然后整洁地展示给你。你可以对上面这个函数尝试一下,只是在你的程序中包括帮助(printMax)。记住按问退出帮助。
自动化工具也可以以同样的方式从你的程序中提取文档。因此,我强烈建议你对你所写的任何正式函数编写文档字符串。随你的Python发行版附带的pydoc命令,与帮助()类似地使用文档字符串。
感谢各位的阅读!关于关闭Python文档字符串的方法就分享到这里了,希望以上内容可以对大家有一定的帮助,让大家可以学到更多知识。如果觉得文章不错,可以把它分享出去让更多的人看到吧!
