Python 有一个甚是优美的功能称作文档字符串(Documentation Strings) ,在称呼它时通常会使用另一个短一些的名字docstrings。DocStrings 是一款你应当使用的重要工具,它能够帮助你更好地记录程序并让其更加易于理解。令人惊叹的是,当程序实际运行时,我们甚至可以通过一个函数来获取文档!
# 文档字符串(Documentation Strings)
def print_max(x,y):
'''打印两个数值中的最大数。
这两个数都应该是整数'''
# 如果可能,将其转换至整数类型
x = int(x)
y = int(y)
if x>y:
print(x,'is maximum')
else:
print(y,'is maximum')
print_max(3,5)
print(print_max.__doc__)
输出:
5 is maximum
打印两个数值中的最大数。
这两个数都应该是整数
工作原理:
函数的第一行逻辑行中的字符串是该函数的 文档字符串(DocString) 。
该文档字符串所约定的是一串多行字符串,其中第一行
以某一大写字母开始,以句号结束。
第二行
为空行,后跟的第三行
开始是任何详细的解释说明。 在此强烈建议你在你所有重要功
能的所有文档字符串中都遵循这一约定
通过使用函数的 __doc__
(注意其中的双下划綫) 属性(属于函数的名称) 来获取
函数 print_max 的文档字符串属性。