Python - 注释

上一页
下一页

Python 注释

Python 注释是程序员可读的 Python 源代码中的解释或注解。添加它们的目的是为了使源代码更容易被人理解，Python 解释器会忽略它们。注释增强了代码的可读性，并帮助程序员更仔细地理解代码。

示例

如果我们执行下面给出的代码，生成的输出将简单地将“Hello, World！”打印到控制台，因为注释会被 Python 解释器忽略，并且不会影响程序的执行：

# This is a comment
print("Hello, World!")

Python 支持三种类型的注释，如下所示：

  • 单行注释
  • 多行注释
  • 文档字符串注释

Python 中的单行注释

Python 中的单行注释以井号 (#) 开头，并扩展到行尾。它们用于提供关于代码的简短解释或注释。它们可以放在它们描述的代码上方自己的行上，也可以放在代码行的末尾（称为内联注释），以提供关于该特定行的上下文或说明。

示例：独立单行注释

独立单行注释是指占据整行的注释，以井号 (#) 开头。它放在其描述或注释的代码上方。

在此示例中，独立单行注释放置在“greet”函数上方：

# Standalone single line comment is placed here
def greet():
   print("Hello, World!")
greet()

示例：内联单行注释

内联单行注释是指出现在与代码相同的行上的注释，位于代码之后，前面有井号 (#)。

此处，单行内联注释跟在print("Hello, World!")语句之后 −

print("Hello, World!")  # Inline single line comment is placed here

Python中的多行注释

在Python中，多行注释用于提供跨越多行的较长解释或注释。虽然Python没有多行注释的特定语法，但有两种常用的方法：连续单行注释和三引号字符串 −

连续单行注释

连续单行注释指的是在每一行的开头使用井号 (#)。此方法通常用于较长的解释或将代码的各个部分隔开。

示例

在这个例子中，多行注释用于解释阶乘函数的目的和逻辑 −

# This function calculates the factorial of a number
# using an iterative approach. The factorial of a number
# n is the product of all positive integers less than or
# equal to n. For example, factorial(5) is 5*4*3*2*1 = 120.
def factorial(n):
   if n < 0:
      return "Factorial is not defined for negative numbers"
   result = 1
   for i in range(1, n + 1):
      result *= i
   return result

number = 5
print(f"The factorial of {number} is {factorial(number)}")

使用三引号字符串的多行注释

我们可以使用三引号字符串(''' 或 """) 来创建多行注释。这些字符串在技术上是字符串字面量，但如果它们没有赋值给任何变量或用于表达式，则可以用作注释。

此模式通常用于块注释或在需要详细解释的代码部分进行文档说明。

示例

这里，三引号字符串提供了对“gcd”函数的详细解释，描述了它的目的和使用的算法 −

"""
This function calculates the greatest common divisor (GCD)
of two numbers using the Euclidean algorithm. The GCD of
two numbers is the largest number that divides both of them
without leaving a remainder.
"""
def gcd(a, b):
   while b:
      a, b = b, a % b
   return a

result = gcd(48, 18)
print("The GCD of 48 and 18 is:", result)

使用注释进行文档编写

在Python中，文档注释（也称为文档字符串）提供了一种在代码中加入文档的方法。这对于解释模块、类、函数和方法的目的和用法非常有用。有效地使用文档注释可以帮助其他开发人员理解你的代码及其目的，而无需阅读实现的所有细节。

Python文档字符串

在Python中，文档字符串是一种特殊的注释类型，用于记录模块、类、函数和方法。它们使用三引号(''' 或 """) 编写，并放在它们所记录的实体定义的紧后方。

文档字符串可以通过编程方式访问，这使得它们成为Python内置文档工具不可或缺的一部分。

函数文档字符串示例

def greet(name):
   """
   This function greets the person whose name is passed as a parameter.

   Parameters:
   name (str): The name of the person to greet

   Returns:
   None
   """
   print(f"Hello, {name}!")
greet("Alice")

访问文档字符串

可以使用.__doc__属性或help()函数访问文档字符串。这使得可以轻松地从交互式Python shell或代码中直接查看任何模块、类、函数或方法的文档。

示例：使用.__doc__属性

def greet(name):
    """
    This function greets the person whose name is passed as a parameter.

    Parameters:
    name (str): The name of the person to greet

    Returns:
    None
    """
print(greet.__doc__)

示例：使用help()函数

def greet(name):
    """
    This function greets the person whose name is passed as a parameter.

    Parameters:
    name (str): The name of the person to greet

    Returns:
    None
    """
help(greet)
打印页面
上一页
下一页
广告