单行注释和多行注释

Python 注释是代码中用于解释说明的非执行性文本，主要分为以下两种类型：

一、单行注释

1. 语法形式

   使用 # 符号开头的行即为单行注释，例如：

   # 这是一个单行注释，用于解释代码作用
   print("Hello, World!")
   

2. 特点

   • 仅限单行使用，后续代码会被忽略。

   • 建议在注释后添加空格以提高可读性。

二、多行注释

1. 语法形式

   使用三个单引号 ''' 或三个双引号 """ 包裹的块状文本，例如：

   """
   这是一个多行注释，可跨越多行
   用于详细说明函数或复杂逻辑
   """
   def add_numbers(a, b):
       return a + b
   

2. 特点

   • 可包含换行，适合长文本说明。

   • 若位于函数、类或模块开头，则作为文档字符串（docstring），可通过 help（） 函数查看。

三、特殊说明

• 文档字符串（Docstrings）

  是多行注释的进阶用法，主要用于函数、类和模块的文档说明。例如：

  def greet(name):
      """  
      向用户发送问候语  
      Args:  
        name (str): 用户名称  
      Returns:  
        问候语字符串  
      """  
      return f"你好, {name}!"
  

  文档字符串会自动存储在对象的 __doc__ 属性中，可通过 help（greet） 调用显示。

• 注释规范建议

  • 简单说明用单行注释，复杂逻辑用多行注释。

  • 保持注释与代码同步更新。

  • 使用行末注释（#）补充单行说明。

通过合理使用注释，可提升代码可读性和维护性。