在 Python 中,你可以使用行注释和块注释来添加注释说明你的代码。
- 行注释:行注释以
#
开头,用于在代码的同一行添加注释。注释内容在#
符号后面,并且直到行尾都是注释。行注释通常用于对特定行或代码的解释、说明或标记。
以下是行注释的示例代码:
# 这是一个行注释,用于解释下面一行的代码
x = 10 # 初始化变量 x
- 块注释:块注释也被称为多行注释,用于注释多行代码或块。块注释使用三个引号(单引号或双引号)将注释内容包裹起来。注释块开始的三个引号后面通常有一行空行,然后是注释内容,之后再以三个引号闭合注释块。
以下是块注释的示例代码:
"""
这是一个块注释,用于注释多行代码或块。
你可以在这里提供更详细的代码解释。
"""
def calculate(x, y):
"""
这是一个函数的块注释,用于解释函数的作用和参数。
参数:
- x: 第一个参数
- y: 第二个参数
返回:
- 两个参数的和
"""
return x + y
块注释通常用于函数、类、模块等的开头,提供更详细的说明。它们也可以用于临时注释掉一部分代码。
注释是代码中很重要的工具,可以帮助他人理解代码的目的和功能。建议在编写代码时养成良好的注释习惯,以便代码的可读性和可维护性更好。