python注释

在Python中,注释是用来帮助理解代码的“悄悄话”,它们不参与程序的实际运行。Python提供了两种主要的注释方式:

  1. 单行注释
  • 使用#符号开头,后面跟随的内容都会被Python解释器忽略。

  • 单行注释适合简短的说明,例如解释代码的作用或某个特定操作的目的。

  • 示例:

    # 这是一个单行注释
    print("Hello, World!")  # 这里对下面代码的说明
    ```

2. **多行注释** <b class="card40_249__sup_a7f6" data-sup="sup">2</b>:

- 可以使用三个单引号(`'''`)或三个双引号(`"""`)将注释内容括起来<b class="card40_249__sup_a7f6" data-sup="sup">5</b>。

- 多行注释适合写较长的说明文字,例如解释一段代码的功能和逻辑<b class="card40_249__sup_a7f6" data-sup="sup">4</b>。

- 示例:

```python
    '''
    这是一个多行注释
    可以在这里写很多行的说明文字
    用来解释下面一段代码的功能和逻辑
    '''
    a = 10
    b = 20
    print(a + b)  # 这里对后面计算 a 和 b 相加并打印结果的代码进行了说明
    ```

### 注意事项<b class="card40_249__sup_a7f6" data-sup="sup">3</b>

- 注释和代码之间建议加一个空格,以提高可读性<b class="card40_249__sup_a7f6" data-sup="sup">2</b>。

- 三引号注释(实际上是一个多行字符串常量)也可以用于注释,但它们通常用于函数和类的文档字符串(docstring),这是一种更专业的做法<b class="card40_249__sup_a7f6" data-sup="sup">3</b>。

### 示例

以下是一个综合示例,展示了单行注释和多行注释的使用:

```python
# 这是一个单行注释,用于解释下面代码的功能
print("Hello, World!")  # 这里对下面代码的说明

'''
这是一个多行注释
可以在这里写很多行的说明文字
用来解释下面一段代码的功能和逻辑
'''
a = 10
b = 20
print(a + b)  # 这里对后面计算 a 和 b 相加并打印结果的代码进行了说明

# 文档字符串(docstring)是函数和类的专属“名片”
def add(x, y):
    """
    计算两个数的和

    参数:
    x (int): 第一个加数
    y (int): 第二个加数

    返回:
    int: 两个数的和
    """
    return x + y

result = add(5, 3)
print(result)  # 输出:8

通过这些注释,代码的可读性和可维护性得到了显著提高。

Top