python函数文档可以大大提高开发的效率，让别人一看你这个函数，就马上知道这个函数的功能，以及需要什么类型的参数，下面为大家详细讲解一下python函数文档实用方法。
函数文档及作用
作用：
函数也需要添加注释, 方便函数功能、参数以及返回值的含义能够被调用者知悉. 能够在调用时快捷查看函数相关信息 和单行注释相比：
普通的单行、多行注释, 需要查看函数定义时才能看到
快捷键
通过 ctrl + q 快捷键可以查看函数信息, 也可以通过 help() 函数来查看函数信息
工具：
DocString 是一个重要的工具, 由于它帮助你的程序文档更加简单易懂
案例：
# 单行函数文档字符串•
def my_function(param):
"""函数做了什么事, 返回什么结果."""
return param + 10
# 多行函数文档字符串
def my_add(num1, num2):
"""计算两个整数的和. :param int num1: 加法运算的左操作数 :param int num2: 加法运算的右操作数 :return 返回两个操作数相加的结果 """
result = num1 + num2
return result
文章来源网络，作者：运维，如若转载，请注明出处：https://shuyeidc.com/wp/206885.html<
