Python 中怎么注释代码？

Python 中的几种注释的方法！

一、单行注释

在 Python 中，单行注释使用井号（#）符号。

# 这是一个单行注释
print("Hello, World!")  # 这也是一个单行注释

井号后的内容都会被 Python 解释器忽略，不会执行。

二、多行注释

多行注释可以使用连续的单行注释。

# 这是一个
# 多行注释
print("Hello, World!")

每行都需要以井号开头，这样可以注释掉多行代码。

三、文档字符串

另一个注释多行的方法是使用三引号（'''或"""）。

"""
这是一个多行注释
可以用于函数、类、模块的文档字符串
"""
print("Hello, World!")

这种方式常用于函数或类的文档字符串，提供关于代码的详细说明。

四、文档字符串示例

在函数或类中使用文档字符串。

def example():
    """
    这是一个示例函数
    该函数不执行任何操作
    """
    pass

这种注释在函数或类定义的第一行，提供关于它们的详细描述。

五、内联注释

内联注释放在代码行的末尾。

x = 10  # 这是一个内联注释

内联注释应与代码保持一定距离，以提高可读性。

六、总结

总结一下，Python 提供了单行注释、多行注释和文档字符串三种主要注释方法。合理使用注释可以提高代码的可读性和可维护性。