#(单行);三引号(多行)
Python语言中的代码注释符号主要有以下两种类型,需根据注释的用途和场景选择使用:
一、单行注释
- 符号说明
使用井号 #
开头,从 #
到行尾的所有内容均被忽略,不会被执行。
- 使用规范
-
可出现在代码行任意位置,但建议紧跟代码行左侧,便于阅读。
-
若代码行已包含冒号(如函数定义、条件语句等),注释需放在上一行。
- 示例
# 这是一个单行注释
print("Hello, World!") # 这是另一行注释
二、多行注释
- 符号说明
使用三个单引号 '''
或三个双引号 """
将注释内容包裹起来,可跨越多行,通常用于函数说明、类文档等场景。
- 特殊用途
-
三个单引号或双引号必须成对出现,且需单独占一行,通常位于模块或函数顶部。
-
若注释内容未被赋值或使用,Python会将其视为文档字符串,可通过
help(function_name)
调用显示。
- 示例
def greet(name):
"""
向指定人打招呼
参数:
name (str): 要打招呼的人的名字
返回:
str: 问候语
"""
return f"Hello, {name}"
补充说明
- 文档字符串(Docstrings)
多行注释的一种特殊形式,用于函数、类、模块等的文档说明,可通过 help()
函数访问。
- 编码声明
使用 # coding=utf-8
或 # coding=gbk
指定文件编码,避免中文字符报错。
通过合理使用单行和多行注释,可显著提升代码的可读性和可维护性。