Python学习之路-函数-文档字符串

简介: 开发者学堂课程,了解Python语言的基本特性、编程环境的搭建、语法基础、算法基础等,了解Python的基本数据结构,对Python的网络编程与Web开发技术具备初步的知识,了解常用开发框架的基本特性,以及Python爬虫的基础知识。课程地址:https://developer.aliyun.com/learning/course/601/detail/8729

help()函数是Python中的内置函数

通过help()函数可以查询python中函数的用法

语法:help(函数对象)

比如获取 print 的函数用法,注意是直接输入对象

help(print)

得到了print函数的详细用法

image.png

我们试一下自定义的函数,看看可不可以获取到用法

deffn(a,b,c):
return10help(fn)

image.png

函数的结构显示出来了,因为在定义函数时没有写说明,所以运行出来的结果没有上面的 print 后面跟的说明,怎么加上说明呢。


文档字符串(doc str)

在定义函数时,可以在函数内部编写文档字符串,文档字符串就是函数的说明,当我们编写了文档字符串时,就可以通过help()函数来查看函数的说明

其实直接在函数的第一行写一个字符串就是文档,但是一般我们会使用三重引号,我们这个长字符串是可以跨行写,这是文档字符串的示例,可以写 函数的作用 函数的参数 ,参数 a  的作用是什么,类型是什么,默认值等等。

deffn(a:int,b:float,c:str='hello')->int:
'''    这是一个字符串    函数的作用。。。。。。    函数的参数:        a:作用,类型,默认值。。。。。        b:作用,类型,默认值。。。。。        c:作用,类型,默认值。。。。。    '''return10help(fn)

image.png

我可以在 a 后面写一个:int  在  b 后面:bool  在 c 后面加入: str

这样通过它我能看出来需要什么类型,但是注意

这只是一个描述,没有其他任何作用,没有强制性。这时候在看文档字符串,能看出来什么类型了,更加清晰。

Fn(a:int, b:bool, c:str)

假如 c 有默认值,有默认值可以直接写 c:str = ‘hello’  默认值就是 hello

也可以在后面写一个  -> str:

这表示函数的返回值是一个字符串,str 是 int,返回值就是整型

相关文章
|
1月前
|
Python
Python之函数详解
【10月更文挑战第12天】
Python之函数详解
|
1月前
|
存储 数据安全/隐私保护 索引
Python 散列类型三以及函数基础
【10月更文挑战第11天】
Python 散列类型三以及函数基础
|
26天前
|
测试技术 数据安全/隐私保护 Python
探索Python中的装饰器:简化和增强你的函数
【10月更文挑战第24天】在Python编程的海洋中,装饰器是那把可以令你的代码更简洁、更强大的魔法棒。它们不仅能够扩展函数的功能,还能保持代码的整洁性。本文将带你深入了解装饰器的概念、实现方式以及如何通过它们来提升你的代码质量。让我们一起揭开装饰器的神秘面纱,学习如何用它们来打造更加优雅和高效的代码。
|
28天前
|
弹性计算 安全 数据处理
Python高手秘籍:列表推导式与Lambda函数的高效应用
列表推导式和Lambda函数是Python中强大的工具。列表推导式允许在一行代码中生成新列表,而Lambda函数则是用于简单操作的匿名函数。通过示例展示了如何使用这些工具进行数据处理和功能实现,包括生成偶数平方、展平二维列表、按长度排序单词等。这些工具在Python编程中具有高度的灵活性和实用性。
|
30天前
|
Python
python的时间操作time-函数介绍
【10月更文挑战第19天】 python模块time的函数使用介绍和使用。
31 4
|
1月前
|
存储 Python
[oeasy]python038_ range函数_大小写字母的起止范围_start_stop
本文介绍了Python中`range`函数的使用方法及其在生成大小写字母序号范围时的应用。通过示例展示了如何利用`range`和`for`循环输出指定范围内的数字,重点讲解了小写和大写字母对应的ASCII码值范围,并解释了`range`函数的参数(start, stop)以及为何不包括stop值的原因。最后,文章留下了关于为何`range`不包含stop值的问题,留待下一次讨论。
22 1
|
1月前
|
安全 数据处理 数据安全/隐私保护
python中mod函数怎么用
通过这些实例,我们不仅掌握了Python中 `%`运算符的基础用法,还领略了它在解决实际问题中的灵活性和实用性。在诸如云计算服务提供商的技术栈中,类似的数学运算逻辑常被应用于数据处理、安全加密等关键领域,凸显了基础运算符在复杂系统中的不可或缺性。
21 0
|
3月前
|
IDE API 开发工具
|
6月前
|
IDE 开发工具 开发者
Python函数说明文档:编写清晰易懂的文档字符串
Python函数说明文档:编写清晰易懂的文档字符串
102 1
|
6月前
|
Python
Python 的编码规范和最佳实践: 解释 Python 的文档字符串(docstring)是什么?如何编写好的文档字符串?
【4月更文挑战第16天】Python docstrings是注释,用于说明代码功能。放置于对象定义前,用三引号包围。遵循PEP 257,使用reStructuredText格式,确保简洁、完整、准确。例如: ```markdown ```python def add(a, b): """ 计算两数之和。 参数: a -- 第一加数 b -- 第二加数 返回: 和 """ return a + b ``` ```
84 0
下一篇
无影云桌面