注释

在 Python 中，注释是用来解释代码的非执行文本。它们帮助开发者和其他阅读代码的人更好地理解代码的意图和行为。注释对于增加代码的可读性和维护性至关重要。

注释的类型：

1. 单行注释：

   • 以 # 符号开头。
   • 只对 # 后的同一行有效。
2. 多行注释：

   • 虽然 Python 没有专门的多行注释语法，但可以使用三引号（''' 或 """）来创建在视觉上类似的效果。
   • 实际上，三引号用于多行字符串，但可以用作块注释。

注释的用途：

• 解释复杂的代码逻辑：有助于其他人理解代码中复杂部分的工作原理。
• 标记待办事项：使用注释标记未来需要修改或完成的代码部分。
• 调试代码：临时注释掉某些代码行，帮助找出错误。

示例代码：

# 这是一个单行注释

# 下面是一个变量定义
my_variable = 5

# 下面是一个函数定义
def my_function():
    # 返回变量值的两倍
    return my_variable * 2

"""
这是一个多行注释
可以覆盖多行
通常用于解释复杂的代码逻辑或者文档描述
"""

# 使用函数
result = my_function()
print(result)  # 打印结果

# TODO: 未来需要添加更多功能

在这个例子中，使用了单行注释和多行注释来解释代码的不同部分。单行注释用于简短的说明，而多行注释则用于更详细的描述。注意，虽然多行注释使用了三引号，但它们实际上是多行字符串，并不是 Python 语法中专门用于注释的元素。