给函数写文档是为了让后人可以更好地理解你的函数设计逻辑,对于一名优秀的程序员来说,养成编写函数文档的习惯无疑是非常必要的。
作用
大型的项目往往是由一个团队来合作完成,文档的阅读可以使即将编写的代码互相衔接。
使用
编写函数
def function(num):
"""
将输入的数字乘以2再加1
"""
return num * 2 + 1
显然,引号内的内容就是函数的文档,引号外的内容是函数的返回操作。
查看文档
print(function.__doc__)
输出内容
将输入的数字乘以2再加1