注释是代码的“说明书”,能帮助我们和别人理解代码的作用,也方便自己以后回顾。Python的注释语法简单,但初学者可能会混淆单行和多行注释的写法,今天就用简单的语法搞定它们!
一、单行注释:最常用的“一句话说明”¶
在Python中,单行注释用 # 开头,# 后面的内容会被Python自动忽略,不会执行。
用法示例:
# 这是单行注释,解释下面这行代码的作用
print("Hello, Python!") # 也可以写在代码行的右边,说明代码功能
# 注意:# 后面的内容才是注释,前面的空格不影响
# 但如果#前面有代码,必须用空格隔开,否则会报错
关键点:
- # 只对它所在行的后续内容生效,不会影响其他行。
- 不要把 # 写在字符串里面,比如 print("# Hello") 会输出 # Hello(# 被当作字符串的一部分)。
二、多行注释:需要“一大段说明”¶
Python没有像其他语言(如Java的/* */)那样的多行注释语法,但可以用 三个单引号 ''' 或三个双引号 """ 实现多行注释。
用法示例:
# 多行注释:直接用三个单引号,不赋值给变量
'''
这是第一行多行注释
可以写很多行内容
解释一段代码的作用
比如这里要说明某个函数的功能
'''
# 也可以用三个双引号,效果一样
"""
这是用双引号的多行注释
换行内容也会被当作注释
"""
注意:
- 这种多行注释本质是“字符串”,如果写在函数内部,会被当作函数的 文档字符串(docstring),可以通过 help() 查看,比如:
def greet():
"""
打印一句问候语
"""
print("Hello!")
help(greet) # 调用 help() 会显示 docstring 内容
但作为初学者,只需记住:多行注释用三个引号,不用赋值变量,直接写在代码里即可。
三、注释的“避坑指南”¶
- 不要用注释“隐藏”代码:比如
# print("这段代码被注释了")虽然没执行,但这样的注释没有意义,应该直接删除或保留真实代码。 - 避免冗余注释:比如
# 这行代码是打印就没必要,直接看代码逻辑更清晰。注释应解释“为什么这么写”,而不是“做了什么”。 - 多行注释别和字符串混淆:比如
my_var = '''这是注释'''会把字符串赋值给my_var,虽然不影响程序运行,但这不是注释的正确用法,注释应该直接用三个引号,不赋值变量。
总结¶
Python注释其实很简单:
- 单行注释:用 #,适合解释单句代码。
- 多行注释:用 ''' 或 """,适合大段说明。
记住这两个语法,就能轻松写出清晰的注释,让你的代码“会说话”!