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