二十二、Python中函数的注释

在Python中，函数注释是一种用于对函数的功能、参数、返回值等关键信息进行说明的方式，它可以帮助开发者更好地理解代码，也方便后续代码的维护和协作开发。以下是关于Python函数注释的详细介绍：

1.函数文档字符串（Docstring）

• 基本格式与位置：
  • 函数的文档字符串通常放在函数定义的内部，作为函数体的第一条语句，使用三引号（""" 或 '''）括起来。例如：

  def my_function():
      """这是一个简单的函数文档字符串示例，用于描述函数的基本情况。"""
      pass
  

• 作用与意义：
  • 它可以清晰地阐述函数的用途，比如这个函数是用来解决什么问题、实现何种业务逻辑等。
  • 说明函数的参数情况，包括参数的含义、数据类型要求（虽然Python是动态类型语言，但可以在文档字符串里提示期望的类型）等。
  • 告知调用者函数的返回值情况，像返回的数据类型、返回值代表的具体含义等。

2.常用的文档字符串规范