Python的多行注释符号是三个连续的单引号'''
或三个连续的双引号"""
,用于一次性注释多行内容(包含一行),语法为'''注释内容'''
或"""注释内容"""
。多行注释通常用于为文件、模块、类或函数添加功能描述或版权信息,但需注意不支持嵌套使用,且当引号作为字符串的一部分时会被视为代码而非注释。
-
语法与基本用法
多行注释以三引号(单/双)包裹内容,例如:python复制
''' 这是多行注释 可跨越多行 '''
或
python复制
""" 同样适用于多行注释 """
两种形式功能完全等效,按代码风格选择即可。
-
核心注意事项
- 避免嵌套:如
'''外层注释'''内层注释'''
会引发语法错误。 - 字符串与注释的区别:若三引号用于字符串(如
print('''Hello''')
),则不被视为注释。 - 调试用途:临时注释大段代码时,三引号比逐行添加
#
更高效。
- 避免嵌套:如
-
替代方案与场景建议
- 单行注释链:通过每行添加
#
也可实现多行注释,适合需保留的永久性说明。 - IDE快捷键:如PyCharm的
Ctrl+/
可快速注释选中行,提升效率。
- 单行注释链:通过每行添加
合理使用多行注释能显著提升代码可读性,但需注意避免滥用。对于复杂逻辑,优先结合单行注释与文档字符串(Docstring)确保清晰性。