Python 注释

在本文中，我们将学习如何在我们的程序中编写注释。我们还将了解单行注释、多行注释、文档字符串和其他Python注释。

Python注释简介

我们可能希望描述我们开发的代码。例如，我们可能希望记录一段脚本函数的功能原因。我们利用注释来实现这一点。通常使用注释来解释公式、过程和复杂的业务逻辑。当运行程序时，Python解释器会忽略注释并仅解释脚本。Python中有三种类型的注释：单行注释、多行注释和文档字符串。

使用注释的优点

当我们在代码中使用注释时，我们的代码更易理解。通过使程序更易理解，它可以帮助我们记住为什么创建了特定代码段。

此外，我们可以利用注释来忽略评估其他代码部分时的特定代码。这种简单的技巧可以阻止某些行的运行，或者为程序创建一个快速的伪代码。

以下是注释的一些常见用途：

• 代码的可读性
• 限制代码执行
• 提供程序或项目元数据的概述
• 向代码添加资源

Python中的注释类型

在Python中，有三种类型的注释。它们如下所示：

单行注释

在Python中，单行注释已被证明是为参数、函数定义和表达式提供快速说明的有效方法。Python的单行注释是以井号#开始的注释，直到该行结束。如果注释延续到下一行，请在下一行添加井号并继续注释。考虑下面的代码片段，它展示了如何使用单行注释：

代码

# This code is to show an example of a single-line comment
print( 'This statement does not have a hashtag before it' )

输出:

This statement does not have a hashtag before it

以下是注释：

# This code is to show an example of a single-line comment

Python编译器忽略这行代码。

# 之后的所有内容都被省略了。因此，我们可以将上述程序放在一行中，如下所示：

代码

print( 'This is not a comment' ) # this code is to show an example of a single-line comment

输出：

This is not a comment

这个程序的输出将与上面的例子相同。计算机会忽略#后面的所有内容。

多行注释

Python不提供多行注释的功能。然而，确实有许多方法可以创建多行注释。

通过多个井号(#)进行注释

在Python中，我们可以多次使用井号(#)来构建多行注释。每一行在前面加上一个(#)将被视为单行注释。

代码

# it is a
# comment
# extending to multiple lines

在这种情况下，每一行都被视为注释，并且它们都被省略了。

使用字符串文字

因为Python会忽略没有分配给变量的字符串表达式，所以我们可以将它们用作注释。

代码

'it is a comment extending to multiple lines'

我们可以观察到，在运行这段代码时，不会有任何输出；因此，我们使用三重引号（”””) 中的字符串作为多行注释。

Python文档字符串

紧跟在定义函数后面的三重引号包围的字符串被称为Python文档字符串。它的设计目的是将开发的Python模块、方法、类和函数的文档链接在一起。它被放置在函数、模块或类的下方，用于解释它们的功能。然后可以使用doc属性在Python中轻松访问到文档字符串。

代码

# Code to show how we use docstrings in Python

def add(x, y):
    """This function adds the values of x and y"""
    return x + y

# Displaying the docstring of the add function
print( add.__doc__ )

输出：

This function adds the values of x and y