在Python的函数中，可以通过说明和注释加强使用者对该函数的理解与运用。

1 函数的说明

1.1 函数说明的添加

可以通过”””对实现对函数的说明的添加，如图1所示。

图1 函数说明的添加

图1中定义了一个名为my_function()的函数，在该函数中使用”””对添加了说明。一般来说，函数说明的第一行指定了该函数的作用；第二行是空行，作为分隔；第三行说明调用函数的方法。

1.2 函数说明的显示

通过“函数名.__doc__”显示函数的说明，如图2所示。

图2 函数说明的显示

2 函数的注释

2.1 函数注释的添加

可以添加函数参数的注释和返回值的注释，如图3所示。

图3 函数注释的添加

以上定义了名为my_function的函数，该函数有一个名为egg的参数，egg参数后面的“:str”是对该参数的注释，表示egg的类型是str，如图3①所示。在函数参数列表与冒号之间的部分是对函数返回值的注释，如图3②所示，表示my_function的返回值是str。

2.2 函数注释的显示

通过“函数名.__annotations__”显示函数的注释，如图4所示。

图4 函数注释的显示

Python中函数的说明与注释相关推荐

不显示参数名_第51p，万能参数与返回值，Python中函数的返回值
大家好,我是杨数Tos,这是<从零基础到大神>系列课程的第51篇文章,第三阶段的课程:Python进阶知识:详细讲解Python中的函数(四)====>函数的参数与返回值(下篇). ...
python中函数的使用
python中函数的使用函数:一个带有名字的代码块,用于执行某些特定的任务.例如:当某些代码需要多次被重复执行时,就可以将代码封装为一个函数.当需要使用函数中的代码时,直接调用即可. 1.函数的使用 ...
站长在线Python精讲：在Python中函数的定义与创建详解
欢迎你来到站长在线的站长学堂学习Python知识,本文学习的是<在Python中函数的定义与创建详解>.本文的主要内容有:函数的定义.函数的定义规则.函数的创建. 目录 1.函数的定义 2 ...
python 定义函数方法,python中函数如何定义？python函数的调用方法介绍
本篇文章给大家带来的内容是关于python中函数如何定义?python函数的调用方法介绍,有一定的参考价值,有需要的朋友可以参考一下,希望对你有所帮助. 1. 函数的概念,函数是将具有独立功能的代码块 ...
python参数传递方法_深入理解python中函数传递参数是值传递还是引用传递
python 的深入理解python中函数传递参数是值传递还是引用传递目前网络上大部分博客的结论都是这样的: Python不允许程序员选择采用传值还是传引用.Python参数传递采用的肯定是&q ...
python中函数和方法的区别？Python编程判断当前获取的对象是函数还是方法
python中函数和方法的区别?Python编程判断当前获取的对象是函数还是方法目录
python教程实例-Python中函数的用法实例教程
本文以数值计算为例讲述了Python中函数的用法,分享给大家供大家参考借鉴之用.具体如下: 我们都知道圆的面积计算公式为: S = πr2 当我们知道半径r的值时,就可以根据公式计算出面积.假设我们需 ...
Python中函数的参数传递方式
Python中函数的参数传递方式 .普通的参数传递 >>> def add(a,b):return a+b >>> print add(1,2) 3 >> ...
python中函数和方法的区别
本篇内容主要介绍从几个维度来介绍下python中函数和方法的区别: 首先,从分类的角度来分析. (1)函数的分类: 内置函数:python内嵌的一些函数. 匿名函数:一行代码实现一个函数功能. 递归函 ...

Python中函数的说明与注释