在编写Python代码时，我们经常会遇到一些需要解释的代码段，这些代码段可能是为了帮助其他人理解我们的代码，也可能是为了在我们以后回顾代码时提供参考，在这些情况下，添加注释就显得尤为重要，注释可以帮助我们更好地理解代码的功能和工作原理，从而提高代码的可读性和可维护性。
Python中的注释有两种形式：单行注释和多行注释。
1、单行注释：使用井号（#）开头，直到行尾。
# 这是一个单行注释
print("Hello, World!") # 这也是一个单行注释
2、多行注释：使用三个单引号（'''）或三个双引号（"""）包围起来。
'''
这是一个
多行注释
'''
print("Hello, World!")
或者
"""
这也是一个
多行注释
"""
print("Hello, World!")
需要注意的是，多行注释不能跨越多行，如果需要跨越多行，可以使用三引号（'''或"""）将注释内容包裹起来。
除了注释之外，我们还可以使用文档字符串（docstring）来为函数、类和模块提供说明，文档字符串是一种特殊的注释，它位于模块、类或函数的开头，用三个引号（'''或"""）包围起来。
def add(a, b):
"""
这个函数接收两个参数，返回它们的和。
:param a: 第一个加数
:param b: 第二个加数
:return: 两个加数的和
"""
return a + b
通过使用注释和文档字符串，我们可以更好地理解和维护我们的代码，从而提高代码的质量和效率。
发表评论