python块注释

# 这是一个块注释的例子

"""
这是一个多行的块注释。
它可以用来解释一段代码的功能、参数和返回值等。
通常用于函数、类或模块的开头，提供详细的文档说明。
"""

def example_function(param1, param2):
    """
    这是一个示例函数。

    参数:
    param1 -- 第一个参数，表示...
    param2 -- 第二个参数，表示...

    返回:
    返回两个参数的和。
    """
    return param1 + param2

# 单行注释只适用于简短的说明
# 而多行块注释则适合更详细的解释

class ExampleClass:
    """
    这是一个示例类。

    该类的主要功能是...
    """

    def __init__(self, value):
        """
        初始化方法。

        参数:
        value -- 初始值，表示...
        """
        self.value = value

    def get_value(self):
        """
        获取当前的值。

        返回:
        当前的值。
        """
        return self.value

解释说明：

• """...""" 用于创建多行块注释，适合详细描述函数、类或模块的功能和用法。
• 单行注释使用 # 符号，适合简短的说明。
• 块注释通常放在函数、类或模块的开头，帮助其他开发者理解代码的作用。