__doc__()函数在Python中的常见用法和代码示例

在Python中，__doc__()函数是对象的一个内置方法，它可以获取对象的文档字符串（docstring）。

文档字符串是一个描述对象的字符串，它通常用来提供有关对象的说明和使用方法。文档字符串可以在类、方法、函数或模块的定义之后通过三引号（'''或"""）来编写。

__doc__()函数可以在运行时获取对象的文档字符串，它返回一个字符串对象，其中包含了对象的文档字符串。以下是__doc__()函数的用法和示例：

1. 获取函数的文档字符串：

def greet(name):
    """This function greets the person with the given name"""
    print("Hello, " + name)

print(greet.__doc__)

输出：

This function greets the person with the given name

2. 获取类的文档字符串：

class Rectangle:
    """This class represents a rectangle"""

    def __init__(self, width, height):
        self.width = width
        self.height = height

print(Rectangle.__doc__)

输出：

This class represents a rectangle

3. 获取模块的文档字符串：

"""This module contains functions for mathematical operations"""

def add(a, b):
    """This function adds two numbers"""
    return a + b

def subtract(a, b):
    """This function subtracts two numbers"""
    return a - b

print(__doc__)

输出：

This module contains functions for mathematical operations

通过__doc__()函数，我们可以在运行时动态获取对象的文档字符串，并将其用于自动生成文档、提供帮助信息以及进行对象的说明和解释。文档字符串是Python中非常重要的一部分，使用__doc__()函数可以方便地访问和利用这些文档字符串。