在 Python 代码中，注释（comments） 用于添加说明和解释，帮助开发者理解代码逻辑。注释不会被 Python 解释器执行，仅用于代码可读性和维护性。Python 提供 单行注释、多行注释和文档字符串（docstring） 三种方式。

---

1. 单行注释（#）

单行注释使用 # 号 作为开头，后面的内容不会被 Python 解释器执行。例如：

# 这是一个单行注释
print("Hello, Python!")  # 这条语句会输出 "Hello, Python!"

💡 注意：

• # 号可以出现在代码行的开头或末尾。
• # 号后面的文本不会被执行，仅作为注释使用。

---

2. 多行注释（连续的 # 或 三引号）

Python 没有专门的多行注释语法，但可以使用以下两种方式：

（1）连续使用 #

# 这是一个多行注释
# 适用于简单的注释
# 每一行都需要使用 #
print("Hello, World!")

（2）使用三引号（''' 或 """）

Python 允许使用三引号（''' 或 """）来编写多行注释：

'''
这是一段多行注释
Python 解释器不会执行这些内容
适用于长篇注释
'''
print("Hello, Python!")

或者：

"""
这是另一个多行注释的示例
三引号可以用单引号或双引号
"""
print("Python is fun!")

💡 注意：

• 三引号的方式 实际上是字符串，而不是严格意义上的注释。如果没有赋值给变量，它不会影响程序执行。
• 推荐用于函数、类或模块的文档字符串（Docstring）。

---

3. 文档字符串（Docstring）

文档字符串（docstring） 是 Python 的特殊注释，用于描述模块、类、方法或函数的作用，可以通过 help() 函数查看。

（1）函数的 docstring

def add(a, b):
    """返回两个数的和"""
    return a + b

print(add.__doc__)  # 输出：返回两个数的和

（2）类的 docstring

class Person:
    """这是一个表示人的类"""
    def __init__(self, name, age):
        self.name = name
        self.age = age

print(Person.__doc__)  # 输出：这是一个表示人的类

（3）模块的 docstring

"""
这是一个示例 Python 模块
包含一些基本函数
"""
def greet():
    """打印问候语"""
    print("Hello, Python!")

print(__doc__)  # 输出模块的 docstring

💡 文档字符串的特点：

• 使用三引号（''' 或 """）。
• 通常用于描述函数、类、模块的功能，帮助其他开发者理解代码。
• 可以用 help(函数名) 查看：

  help(add)

输出：

  Help on function add in module __main__:

  add(a, b)
      返回两个数的和

---

4. 代码规范与注释

• 尽量在代码复杂的地方添加注释，不要在显而易见的地方写注释。例如：

  x = 10  # 这个注释是多余的

• 注释应简洁明了，避免长篇大论影响代码可读性。
• 使用 docstring 编写 API 文档，对于重要的类和函数，建议写清楚输入、输出和功能：

  def multiply(a, b):
      """
      计算两个数的乘积
      参数：
      a -- 第一个数字
      b -- 第二个数字
      返回值：
      两个数的乘积
      """
      return a * b

---

总结

注释类型	语法	适用场景
单行注释	#	代码旁边或单独一行的注释
多行注释	''' 或 """	长段代码注释（不推荐，建议用文档字符串）
文档字符串	''' 或 """	模块、类、函数的详细说明

Python 3 的注释可以帮助你提高代码可读性和可维护性，合理使用注释可以让你的代码更清晰、更易懂！🎯更多详细内容请关注其他相关文章！