DocStrings是一个重要的工具,由于它帮助你的程序文档更加简单易懂
应该尽量使用它。你甚至可以在程序运行的时候,从函数恢复文档字符串。
文档字符串的惯例是一个多行字符串,使用三引号(''' ''')包围
它的首行以大写字母开始,句号结尾。第二行是空行,从第三行开始是详细的描述。 建议在的函数中使用文档字符串时遵循这个惯例。
例子:
__author__ = 'zWX231671'
# 文档字符串是为了使程序更易懂
# 文档字符串的惯例是一个多行字符串,它的首行以大写字母开始,句号结尾。
# 第二行是空行,从第三行开始是详细的描述。 强烈建议 你在你的函数中使用文档字符串时遵循这个惯例。
def max(x, y):
'''DocStrings
compare x and y,then return the bigger one.'''
if x > y:
return x
else:
return y
print(max(2, 3))
# 打印出max这个对象(python中一切皆对象)的__doc__属性
print(max.__doc__)
输入结果为: