Python中函数的说明与注释

在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 函数注释的显示