文章目录
- 单行注释
- 多行注释
- 使用多个 # 符号
- 使用三引号(''' 或 """)
- 特殊注释
- Shebang(Unix/Linux 脚本声明)
- 编码声明(Python 2 需要)
- 文档字符串(Docstring)
在 Python 中,注释(Comments) 用于解释代码,提高可读性,且不会被 Python 解释器执行。Python 支持 单行注释 和 多行注释。
单行注释
使用 # 符号,从 # 开始到行尾的内容都会被忽略。
# 这是一个单行注释
print("Hello, World!") # 这也是注释(行尾注释)
适用场景:
1、简短说明代码功能。
2、临时禁用某行代码(调试时常用):
# print("这行代码不会执行")
多行注释
Python 没有专门的多行注释语法,但可以通过以下两种方式实现:
使用多个 # 符号
# 这是多行注释的第一行
# 这是第二行
# 这是第三行
print("多行注释示例")
使用三引号(‘’’ 或 “”")
虽然三引号是多行字符串的语法,但如果字符串未被赋值给变量,Python 会忽略它,因此可作为注释使用:
'''
这是多行注释(实际上是字符串)
可以写多行内容
Python 会忽略未赋值的三引号字符串
'''
print("三引号作为注释")
如果三引号字符串被赋值给变量,它就是字符串而非注释:
docstring = """这是字符串,不是注释"""
特殊注释
Shebang(Unix/Linux 脚本声明)
在文件首行指定 Python 解释器路径(仅限 Unix/Linux 系统):
#!/usr/bin/env python3
print("Shebang 注释")
编码声明(Python 2 需要)
指定文件编码(Python 3 默认 UTF-8,可省略):
# -*- coding: utf-8 -*-
文档字符串(Docstring)
用于函数、类或模块的说明,用三引号包裹,可通过 doc 属性访问:
def add(a, b):"""计算两个数的和参数: a (int), b (int)返回: int"""return a + bprint(add.__doc__) # 输出文档字符串