单行注释
注释是指在代码中写入的非执行语句,它的作用是让开发人员能够对代码进行解释或者添加备注。在 Python 中,我们可以使用 #
符号来表示注释。
当 Python 解释器遇到 #
符号时,它会忽略从 #
开始到行末的所有内容。例如:
# 这是一个注释
print("Hello, world!") # 这也是一个注释
上面的代码中,第一行和第二行的最后一个 "#" 后面的内容都是注释,它们都不会被 Python 解释器执行。
注释可以帮助开发人员更好地理解代码,并且在代码修改或升级时也能提供足够的帮助。因此,初学者在写代码时应该尽量使用注释,以方便以后的维护和更新。
多行注释
在 Python 中,我们还可以使用三个单引号 '''
或三个双引号 """
来表示多行注释。
例如:
'''
这是一个多行注释,
它可以跨越多行。
'''
"""
这也是一个多行注释,
它也可以跨越多行。
"""
使用三个单引号或三个双引号表示的多行注释,可以跨越多行,并且可以在注释中使用换行符。但需要解释的是,使用三个单引号或三个双引号表示的多行注释,其实本质上不是注释,而是字符串。
在使用三个单引号或三个双引号表示的多行注释时,需要注意:
- 单引号
'
和双引号"
在 Python 中是等价的,可以根据个人喜好选择使用。 - 多行注释的开始和结束都必须使用三个单引号或三个双引号,不能只使用一个或两个。
多行注释在写代码--特此是作为 DocString
--时,很有用,因为其可以让开发人员为代码添加足够丰富的解释或备注,以方便以后的维护和更新。