python：浅析函数文档

最新推荐文章于 2024-10-12 10:21:12 发布

原创最新推荐文章于 2024-10-12 10:21:12 发布 · 1.9k 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#python

python 专栏收录该内容

76 篇文章

订阅专栏

本文深入解析Python函数文档的定义、作用及查看方法，通过实例演示如何利用函数文档提高代码可读性和开发效率。

python：浅析函数文档

相信大家都有这样的体会，当在学习的过程中，看别人的代码不知道是什么意思，是干什么的，所以，为了解决这种问题python退出了函数文档，这大大提高了开发的效率，让别人一看你这个函数，就马上知道这个函数的功能，以及需要什么类型的参数。

1、什么是函数文档

所谓函数文档不过就是对一个函数进行解释说明，并没有其他实质性的意义

2、作用

解释说明该函数是干什么的，实现什么功能，让别人一看就知道你这个函数实现的功能
可以看出参数的个数，以及参数的类型
并且可以看出该函数是否返回一个值，返回了什么值

3、如何查看函数文档

# 以下是自己写的一个小小的案例
def average(a, b, c):
    """
    该函数用于计算三个数的平均值，并返回一个结果
    :param a: int_第一个数
    :param b: int_第二个数
    :param c: int_第三个数
    :return: 返回一个计算结果
    """
    d = (a + b + c) // 3
    print("平均数为：", d)
    return d

快捷键（Ctrl+Q）

在这里插入图片描述

help函数

help(average)
# help方式会直接输出到控制台
# 并且你的函数不能带括号，直接函数名就可以了

在这里插入图片描述

doc

print(average.__doc__)
# 首先函数不能再括号
# 其次要调用__doc__  （前后都是两个下划线）
# doc不会自动输出，需要使用输出语句

在这里插入图片描述

以上均为自己在昨天的学习中掌握的一点点小知识，并通过自己的实践总结，将这些方法罗列出来，如果本篇文章有不完善的地方，还请各位朋友能够指教，谢谢！