DocStrings 文档字符串是一个重要工具，用于解释文档程序，帮助你的程序文档更加简单易懂。
我们可以在函数体的第一行使用一对三个单引号 ”’ 或者一对三个双引号 “”” 来定义文档字符串。
你可以使用 __doc__（注意双下划线）调用函数中的文档字符串属性。
#!/usr/bin/python
# -*- coding: UTF-8 -*- def function():
”’ say something here！
”’
pass print (function.__doc__) # 调用 doc
# -*- coding: UTF-8 -*- def function():
”’ say something here！
”’
pass print (function.__doc__) # 调用 doc
输出结果为：
say something here！
DocStrings 文档字符串使用惯例：它的首行简述函数功能，第二行空行，第三行为函数的具体描述。
#!/usr/bin/python
# -*- coding: UTF-8 -*- def printMax(x,y):
”’打印两个数中的最大值。
x=int(x)
y=int(y)
if x>y:
print(x,‘最大‘)
else:
print(y,‘最大‘) printMax(3,5)
print (printMax.__doc__) # 调用 doc
# -*- coding: UTF-8 -*- def printMax(x,y):
”’打印两个数中的最大值。
两个值必须都是在整形数。
”’x=int(x)
y=int(y)
if x>y:
print(x,‘最大‘)
else:
print(y,‘最大‘) printMax(3,5)
print (printMax.__doc__) # 调用 doc
输出结果为：
5 最大
打印两个数中的最大值。
两个值必须都是在整形数。
声明：本站所有文章，如无特殊说明或标注，均为本站原创发布。任何个人或组织，在未征得本站同意时，禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益，可联系我们进行处理。
评论(0)