python类和函数注释方法

在Python中，类和函数的注释通常用于提高代码的可读性和文档化。主要有两种常见的注释风格：

1. **单行注释** (Single-line comments): 使用井号 (#) 开始的一行作为注释，例如：

# 这是一个单行注释，描述这个函数的功能
def my_function():
    pass

2. **多行注释** (Multiline comments): 使用三个单引号 (`'''`) 或者三个双引号 (`"""`) 来创建多行文本注释，比如：

"""
这是一个多行注释，
它能够跨越多行并解释类或函数的详细说明。
"""
class MyClass:
    # 类内多行注释
    def __init__(self):
        """
        构造函数的多行注释
        """
        pass

3. **文档字符串** (Docstrings): Python特别推荐使用docstring来为模块、类、方法和函数提供详细的说明，这种注释放在函数定义之前，一般用于`__doc__`属性。示例：

def my_function(param1, param2):
    """
    This is a docstring explaining the function's purpose and usage.
    
    参数:
    param1: str
        第一参数的描述
    param2: int
        第二参数的描述
    
    返回:
    bool
        函数返回值的描述
    """
    pass