Python 函数注释

最新推荐文章于 2025-09-01 00:01:42 发布

夜色恬静一人

最新推荐文章于 2025-09-01 00:01:42 发布

阅读量1.1k

点赞数 1

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/code88888/article/details/132772071

Python 专栏收录该内容

316 篇文章 ¥59.90 ¥99.00

订阅专栏

本文详细介绍了Python中函数注释的重要性、基本格式和编写原则，包括描述函数功能、参数、返回值以及异常处理。通过示例展示了如何编写清晰的函数注释，强调了良好注释对提高代码可读性和可维护性的关键作用。

Python 函数注释

函数注释是在Python中编写函数时添加的文档字符串，用于描述函数的功能、参数、返回值以及其他相关信息。良好的函数注释可以提高代码的可读性和可维护性，使其他开发人员更容易理解和使用你编写的函数。本文将详细介绍如何编写函数注释，并提供相应的源代码示例。

函数注释的基本格式如下：

def function_name(param1, param2):
    """
    函数描述

    :param param1: 参数1的描述
    :param param2: 参数2的描述
    :return: 返回值的描述
    """
    # 函数体
    ...

了解本专栏

订阅专栏解锁全文

确定要放弃本次机会？

福利倒计时

: :

立减 ¥

普通VIP年卡可用

立即使用

夜色恬静一人

关注关注

1
点赞
踩
2

收藏

觉得还不错? 一键收藏
0
评论
分享

复制链接

分享到 QQ

分享到新浪微博

扫一扫
举报

举报

专栏目录

订阅专栏

Python函数的注释说明

BUG？不存在的！

08-10

494

在这个例子中，我们定义了一个add函数，它有两个参数a和b，返回值为它们的和。这个文本分为三部分：函数的作用说明、函数参数的说明，和函数返回值的说明。除了使用docstring形式的注释外，还有其他的注释方式，例如在函数体内添加单行注释或块注释。但是，这些注释不会被自动解析为API文档或代码提示，因此对于公共接口的函数来说，docstring形式的注释更加推荐。Python中的函数注释采用类似于docstring的形式，即在函数定义的下一行开始，以一对三引号（‘’'）或双引号（“”"）括起来的文本内容。

第57讲：Python定义函数时添加函数注解

江晓龙的博客

06-12

1万+

定义函数时，为了更加清楚的表示形参和返回值的类型或作用，可以给形参和返回值添加函数注解，从而对形参和返回值做更加充分的解释说明，更久的通俗易懂。通过函数注解，可以清楚的表明这个形参要传递什么样的数据类型，返回值是一个什么样的结果。虽然使用函数注释声明了形参的类型，但是毕竟是一个注释，一种说明，所以Python解释器在执行代码时，会忽略掉函数的注解，因此解释器并不会使用函数注解来检查我们传递的实参的类型，以及返回值的类型。函数注解是可选的，可以添加也可以不添加，函数注解的表示可以是任意的表达式，也可以是一个简

参与评论您还未登录，请先登录后发表或查看评论

python | 三种可变参数简述

以秘

08-27

941

*，传递参数是关键字。在*后的参数通过关键字传递参数，一般作为形式参数时，赋予初始值，表示位置参数结束 def safe_division_c(number, divisor, *, numberzero=False, divisorzero=False): print("===================") print(numberzero) print(divisorzero) if numberzero & divisorzero: pr

Python：函数注解

最新发布

qq_41176800的博客

09-01

1551

函数注解在 Python 中并不是“强制类型”的工具，而是一种增强代码语义的说明机制。在大型项目中，合理地使用函数注解配合工具链，可以有效提高代码质量、可读性和开发效率。它允许在函数的参数和返回值中添加类型提示或说明信息，以增强代码的可读性、可维护性和开发效率。Callable 的格式为：Callable[[参数类型...], 返回类型]注解中的字符串、对象仅作为元信息标签，本身不会被解释器执行类型检查。Python 是动态类型语言，函数注解不会改变运行时行为，泛型使函数/类更通用，适用于多种类型。

Python - 函数注解

lq1757442213的博客

02-25

1681

Python3提供一种语法，用于为函数声明中的参数和返回值附加元数据，或者也可以称之为注释。 def my_function(): """ Something about your function… """ pass # 文档注释可以通过下面这种方式查看 print(my_function.__doc__) 言归正传，看代码： def test(x, y) -> int: return x + y 上述代码中的 ->int 告诉使用者该.

python函数注释 typing模块函数类型注解（函数注解）（指定函数参数和返回值类型）Union注解、Callable注解、Optional可变参数注解。类型提示、类型注解、参数注释（参数类型）

Dontla的博客

07-13

7420

因此，set(“dsf234fdsf”)的结果是一个包含字符串中每个字符的集合：{‘3’, ‘s’, ‘2’, ‘d’, ‘f’, ‘4’}。在函数get_unique_numbers中，参数numbers被注解为List[int]，表示它应该是一个整数类型的列表。然而，当你调用get_unique_numbers(“dsf234fdsf”)时，你传递给函数的参数是一个字符串，而不是一个整数列表。Python的typing模块提供了一种在函数定义中添加类型注解的方式，用于指定函数参数和返回值的类型。

在VSCode使用koroFileHeader自动生成Python代码的头注释与函数注释

木头大左的博客

12-10

799

头注释快捷键Ctrl+Win+I函数注释快捷键Ctrl+Win+T。

python3新特性函数注释Function Annotations用法分析

12-25

本文分析了python3新特性函数注释Function Annotations用法。分享给大家供大家参考，具体如下： Python 3.X新增加了一个特性（Feature），叫作函数注释 Function Annotations 它的用途虽然不是语法级别的硬性要求，...

深入浅析Python 函数注解与匿名函数

12-20

Python 函数注解和匿名函数是编程中两个重要的概念，它们各自有其独特的作用和应用场景。函数注解，虽然在Python解释器层面不强制执行，但却能为代码提供额外的元信息，帮助开发者理解函数的预期输入和输出类型。这...

Python注释

挨踢二天才

03-18

4628

注释是在代码中添加的文本，它们不会被Python解释器执行。注释是程序员用来解释代码的一种方式。Python注释以'#'符号开头，直到行末为止。在Python中，注释有两种类型：单行注释和多行注释。单行注释只能在一行中，而多行注释可以跨越多行。单行注释以'#'符号开头，多行注释以三个单引号（'''）或三个双引号（"""）开头和结尾。# 这是一个单行注释") # 这也是一个单行注释'''这是一个多行注释它可以跨越多行'''

Python：函数注释

田地里的大麦子

10-09

876

它是一个映射（dict），用于将每个参数名（key）映射到其相关的注释（value）。由于参数与注释值为映射关系，当参数的值发生变化时，注释也会随之变化。以上两种注释方法仅有注释功能，不对逻辑判断造成任何影响。参数注释：以冒号（:）标记。返回值注释：以 -> 标记。

Python中函数的说明与注释

hou09tian的博客

04-26

9237

在Python的函数中，可以通过说明和注释加强使用者对该函数的理解与运用。 1 函数的说明 1.1 函数说明的添加可以通过”””对实现对函数的说明的添加，如图1所示。图1 函数说明的添加图1中定义了一个名为my_function()的函数，在该函数中使用”””对添加了说明。一般来说，函数说明的第一行指定了该函数的作用；第二行是空行，作为分隔；第三行说明调用函数的方法。 1.2 函数说明的显示通过“函数名.__doc__”显示函数的说明，如图2所示。图2 函数说明的显示 2

python，给函数添加注释

MrPanda0v0的博客

06-04

639

未添加注释的函数 def func(a=1): print(a) return '成功' func() print(func.__annotations__) # 打印结果为 1 {} 对参数添加注释的函数 def func(a:int=1,b:'设定一个任意数值'=2,c:List[str]=3): print(a,b,c) return '成功' func() print(func.__annotations__) # 打印结果为 1 2 3 {'a': <c

python如何设置开头注释_Python 中如何写注释？还不会的同学赶紧来看一眼吧

weixin_39761645的博客

11-14

1265

前言在写 Python 代码的时候，一个很好的编码实践就是使得你的代码简洁，易懂。组织代码，设置变量，以及给函数有意义的名字，都是几个不错的方法。另外一个提高代码可读性的方式就是使用注释。一个注释就是可以用来解释代码的一段人类可读的解释或者一个注解。例如，如果你写了一个复杂的正则表达式，你可以添加一个注释，描述代码做了什么。Python学习裙：715286036在你的 Python 代码中添加注释...

Python函数注释

qq_63644501的博客

08-12

314

函数注释中的参数和返回值，都是可选的函数注释是一种关联方式，编译时具有函数各个部分的任意Python表达式对于函数注释而言，python不附加任何特定的含义或对注释的意义，python只是让这些表达式可用注释具有的唯一方式是当注释具有意义时，由第三方库解释注释使用者可以使用函数的注释做想做的事如：一个库可能使用基于字符串的注释来提供“改进”的帮助消息另一个库可用于为Python提供类型检查的函数和方法，该库可用使用注释来指示函数的预期输入和返回类型。

Python函数注解

Nxin的小抄本

03-10

7169

函数注解是3.0版本引入的新特性，支持对函数的参数与返回值增加注释。注释可用于记录帮助信息，也可以用于标注类型。除了可以使用__annotations__属性获取外，注释没有其他附加语义。而将强制控制权交给框架，元类与装饰器，而Python则在一旁静观其变。定义1）参数注解变量名 [: 注释] [= 默认值]严格按照先注释后默认值的顺序，且两者都是可选的。注释和默认值都必须是Python表达式，在...

Python--注释