文档字符串 | Python从入门到精通:高阶篇之八

简介: 本节重点介绍了文档字符串的编写要求以及优势。更好地了解函数。

介绍返回值 | Python从入门到精通:高阶篇之七

文档字符串

在了解文档字符串之前,我们需要先去知道help()。
help()是Python中的内置函数,通过help()函数可以查询python中的函数的用法。

语法:help(函数对象)

现在来获取print()函数的使用说明。

help(print)

执行结果:

image.png

我们可以得到print()函数的具体使用说明。包括打印结果还有一些文件说明等。

接下来我们自定义一个函数。

def fn(a,b,c):
     return 10

help(fn)

执行结果:

image.png

此时可以发现,显示出来的信息不是很完全,是因为我们没有给函数去说明,所以没有信息输出,但是我们在开发过程中,有解释意义显然是更好一点。此时就需要解释文档字符串了。

文档字符串(doc str)
在定义函数时,可以在函数内部编写文档字符串,文档字符串就是函数的说明。当我们编写了文档字符串时,就可以通过help()函数来查看函数的说明。文档字符串非常简单,其实直接在函数的第一行写一个字符串就是文档字符串。
我们一般使用一对'''来解释说明。

def fn(a,b,c):
    '''
    这是一个文档字符串的示例

    函数的作用:。。。。。
    函数的参数:
        a,作用,类型,默认值。。。。
        b,作用,类型,默认值。。。。
        c,作用,类型,默认值。。。。
    '''
    return 10

help(fn)

执行结果:

image.png

这个文档字符串不是强制性要求,但是我们应该养成一个良好的习惯,帮助自己理解的同时也可以帮助别人理解。

复杂示例:

def fn(a:int,b:bool,c:str):
    '''
    这是一个文档字符串的示例

    函数的作用:。。。。。
    函数的参数:
        a,作用,类型,默认值。。。。
        b,作用,类型,默认值。。。。
        c,作用,类型,默认值。。。。
    '''
    return 10

help(fn)

执行结果:

image.png

此时假设c有默认值,则可以直接声明:

def fn(a:int,b:bool,c:str='hello')

执行结果:

image.png

我们针对上述代码再次修改,表达返回值类型。

def fn(a:int,b:bool,c:str='hello') -> int:

此时表示的是返回值是int类型。
执行结果:

image.png

对于文档字符串的编写,我们要求一般是用英文进行编写。也根据实际开发情况进行调整。

配套视频课程,点击这里查看

获取更多资源请订阅Python学习站

相关文章
|
15天前
|
测试技术 开发者 Python
Python单元测试入门:3个核心断言方法,帮你快速定位代码bug
本文介绍Python单元测试基础,详解`unittest`框架中的三大核心断言方法:`assertEqual`验证值相等,`assertTrue`和`assertFalse`判断条件真假。通过实例演示其用法,帮助开发者自动化检测代码逻辑,提升测试效率与可靠性。
124 1
|
16天前
|
Python
Python中的f-string:更优雅的字符串格式化
Python中的f-string:更优雅的字符串格式化
203 100
|
16天前
|
开发者 Python
Python中的f-string:高效字符串格式化的利器
Python中的f-string:高效字符串格式化的利器
243 99
|
19天前
|
Python
Python中的f-string:更优雅的字符串格式化
Python中的f-string:更优雅的字符串格式化
|
19天前
|
开发者 Python
Python f-strings:更优雅的字符串格式化技巧
Python f-strings:更优雅的字符串格式化技巧
|
19天前
|
开发者 Python
Python f-string:高效字符串格式化的艺术
Python f-string:高效字符串格式化的艺术
|
1月前
|
Python
使用Python f-strings实现更优雅的字符串格式化
使用Python f-strings实现更优雅的字符串格式化
|
20天前
|
调度 数据库 Python
Python异步编程入门:asyncio让并发变得更简单
Python异步编程入门:asyncio让并发变得更简单
96 5
|
1月前
|
数据采集 存储 XML
Python爬虫入门(1)
在互联网时代,数据成为宝贵资源,Python凭借简洁语法和丰富库支持,成为编写网络爬虫的首选。本文介绍Python爬虫基础,涵盖请求发送、内容解析、数据存储等核心环节,并提供环境配置及实战示例,助你快速入门并掌握数据抓取技巧。
|
1月前
|
大数据 数据处理 数据安全/隐私保护
Python3 迭代器与生成器详解:从入门到实践
简介:本文深入解析Python中处理数据序列的利器——迭代器与生成器。通过通俗语言与实战案例,讲解其核心原理、自定义实现及大数据处理中的高效应用。
77 0

热门文章

最新文章

推荐镜像

更多