python 注释符

python 注释符

4、注释

1、单行注释

• 单行注释用于解释代码中的一行或一小段代码。

• 在Python中，单行注释以#开头，后面的内容都是注释。

• 单行注释可以放在代码的任何位置，但通常放在代码行的上方或旁边。

• 单行注释不会影响代码的执行，Python解释器会忽略它们。

• 单行注释是临时性的，如果你想永久性地禁用某行代码，可以使用注释。

• # 这是一个单行注释  
  print("Hello, World!")  # 这行代码会打印出 "Hello, World!"
  

2、多行注释

• 多行注释用于解释多行代码或代码块。

• 然而，Python本身并没有内置的多行注释语法。

• 虽然使用三引号字符串可以模拟多行注释，但这不是Python官方推荐的做法，因为它们实际上是字符串字面量，只是没有被赋值给任何变量而已。

• 如果你在写代码时经常需要多行注释，可能是你的代码结构需要改进，以便更容易地理解和维护。

  2.1、常用方法

  使用多个单行注释

• # 这是一个  
  # 多行注释  
  # 的示例
  

  使用三引号（''' 或 """）的字符串来模拟多行注释

  '''  
  这是一个  
  多行注释  
  的示例  
  '''  
  print("Hello, World!")  # 这段代码仍然会执行
  

3、文档注释

• 文档注释（也称为Docstrings）是专门用于解释函数、类、模块或方法的文本。

• 它们通常位于函数或类的定义的第一行，并且使用三引号（''' 或 """）包围。

• 文档注释通常遵循特定的格式规范，如PEP 257，以确保一致性和可读性。

• 文档注释可以通过Python的内置help()函数或第三方库（如Sphinx）来生成文档。

• 在编写库或框架时，文档注释尤为重要，因为它们为其他开发者提供了关于如何使用你的代码的重要信息。

• def greet(name):  
      """  
      这个函数用于向用户打招呼。  
    
      参数:  
          name (str): 用户的名字。  
    
      返回:  
          str: 包含问候语的字符串。  
      """  
      return "Hello, " + name
  

4、简要概述

• 单行注释：用于解释代码中的一行或一小段代码。

• 多行注释：通常用于解释多行代码或代码块，但在Python中没有直接的多行注释语法。

• 文档注释：专门用于解释函数、类、模块或方法，并遵循特定的格式规范，以便生成文档。

原文链接：https://blog.csdn.net/Withadream/article/details/138343456