文档字符串 | 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学习站

相关文章
|
6月前
|
SQL 关系型数据库 数据库
Python SQLAlchemy模块:从入门到实战的数据库操作指南
免费提供Python+PyCharm编程环境,结合SQLAlchemy ORM框架详解数据库开发。涵盖连接配置、模型定义、CRUD操作、事务控制及Alembic迁移工具,以电商订单系统为例,深入讲解高并发场景下的性能优化与最佳实践,助你高效构建数据驱动应用。
732 7
|
6月前
|
XML 数据格式 Python
从手动编辑到代码生成:Python 助你高效创建 Word 文档
本文介绍如何用Python实现Word文档自动化生成,结合python-docx、openpyxl和matplotlib库,高效完成报告撰写、数据插入与图表生成,大幅提升办公效率,降低格式错误,实现数据驱动的文档管理。
886 2
|
7月前
|
测试技术 开发者 Python
Python单元测试入门:3个核心断言方法,帮你快速定位代码bug
本文介绍Python单元测试基础,详解`unittest`框架中的三大核心断言方法:`assertEqual`验证值相等,`assertTrue`和`assertFalse`判断条件真假。通过实例演示其用法,帮助开发者自动化检测代码逻辑,提升测试效率与可靠性。
513 1
|
7月前
|
Python
Python中的f-string:更优雅的字符串格式化
Python中的f-string:更优雅的字符串格式化
419 100
|
7月前
|
开发者 Python
Python中的f-string:高效字符串格式化的利器
Python中的f-string:高效字符串格式化的利器
582 99
|
7月前
|
Python
Python中的f-string:更优雅的字符串格式化
Python中的f-string:更优雅的字符串格式化
|
7月前
|
开发者 Python
Python f-strings:更优雅的字符串格式化技巧
Python f-strings:更优雅的字符串格式化技巧
|
6月前
|
Cloud Native 算法 API
Python API接口实战指南:从入门到精通
🌟蒋星熠Jaxonic,技术宇宙的星际旅人。深耕API开发,以Python为舟,探索RESTful、GraphQL等接口奥秘。擅长requests、aiohttp实战,专注性能优化与架构设计,用代码连接万物,谱写极客诗篇。
1217 1
Python API接口实战指南:从入门到精通
|
6月前
|
存储 Java 索引
(Python基础)新时代语言!一起学习Python吧!(二):字符编码由来;Python字符串、字符串格式化;list集合和tuple元组区别
字符编码 我们要清楚,计算机最开始的表达都是由二进制而来 我们要想通过二进制来表示我们熟知的字符看看以下的变化 例如: 1 的二进制编码为 0000 0001 我们通过A这个字符,让其在计算机内部存储(现如今,A 字符在地址通常表示为65) 现在拿A举例: 在计算机内部 A字符,它本身表示为 65这个数,在计算机底层会转为二进制码 也意味着A字符在底层表示为 1000001 通过这样的字符表示进行转换,逐步发展为拥有127个字符的编码存储到计算机中,这个编码表也被称为ASCII编码。 但随时代变迁,ASCII编码逐渐暴露短板,全球有上百种语言,光是ASCII编码并不能够满足需求
268 4
|
6月前
|
存储 Java 调度
Python定时任务实战:APScheduler从入门到精通
APScheduler是Python强大的定时任务框架,通过触发器、执行器、任务存储和调度器四大组件,灵活实现各类周期性任务。支持内存、数据库、Redis等持久化存储,适用于Web集成、数据抓取、邮件发送等场景,解决传统sleep循环的诸多缺陷,助力构建稳定可靠的自动化系统。(238字)
1091 1

推荐镜像

更多