python⽂档字符串_python中的⽂档字符串（docString）有⼀个很奇妙的特性，称为 ⽂档字符串 ，它通常被简称为 docstrings 。DocStrings是⼀个重要的⼯具，由于它帮助你的程序⽂档更加简单易懂，你应该尽量使⽤它。你甚⾄可以在程序运⾏的时候，从函数恢复⽂档字符串！ #!/usr/bin/python
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。

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。