Python 注释用于在代码中添加说明性的文本,以便于理解和维护代码。
注释不会被解释器执行,它们只是用于提供给开发者阅读的信息。
在 Python 中,有两种类型的注释:单行注释和多行注释。
一、单行注释
使用 #
符号来添加单行注释。
# 这是一个单行注释
二、多行注释
使用三个单引号 '''
或三个双引号 """
来创建多行注释。
'''
这是一个多行注释
可以跨越多行
'''
多行注释通常用于函数、类或代码块的文档字符串(docstrings),以提供更详细的说明。
例如,下面是一个包含注释的 Python 程序示例:
# 这是一个简单的 Python 程序
# 它会打印出 "Hello, World!" 字符串
print("Hello, World!") # 打印欢迎信息
# 多行输出,也可以用 """
print("""床前明月光
疑是地上霜""")
在这个示例中,#
后面的文本是注释,不会被执行。print()
函数会被执行,从而打印出 "Hello, World!"。
良好的注释实践可以提高代码的可读性和可维护性,有助于其他开发人员理解您的代码。