2022年 11月 9日

Python 注释块

注释是计算机程序中的一段文本,可提供有关所编写源代码的更多信息。与其他所有编程语言一样,Python 具有三种不同类型的注释:单行注释、多行注释和文档字符串。

Python 注释块介绍

注释用于解释源代码。注释主要用于以下目的。

  1. 提高代码可读性
  2. 测试代码
  3. 解释项目的代码或元数据
  4. 阻止执行特定的代码块

例如,假设您编写了复杂的业务逻辑、公式、算法等。那么我们需要使用解释代码作用的注释来记录它,从而提高 Python 中代码的可读性。

Python解释器在执行代码时忽略注释,只解释代码。

Python 中的注释类型

我们可以在 Python 中使用三种注释。

  1. 单行注释
  2. 多行注释
  3. 文档字符串,又名文档字符串

让我们通过示例详细了解如何在 Python 代码中使用这些注释。

单行注释

单行注释,也称为块注释,以井号 (#) 开头,后跟单个空格和文本字符串。

散列 (#) 仅适用于单行代码,不适用于多行代码。

让我们举一个例子来演示 Python 中的单行注释。

  1. <span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#888888"># 这是一个单行注释示例</span>
  2. <span style="color:#397300">print</span> ( <span style="color:#880000">"Hello World"</span> )</span></span>

内嵌注释

如果您将注释与语句放在同一行,您将拥有内联注释。

与单行注释一样,行内注释也以井号 (#) 开头,后跟空格和注释文本。

让我们举一个例子来演示 Python 中的内联注释。

<span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#397300">print</span> ( <span style="color:#880000">"Hello World"</span> ) <span style="color:#888888"># 这是内联注释的例子</span></span></span>

多行注释

通常,在其他语言如 C、C#、Java 等中,我们可以编写如下所示的多行注释。

  1. <span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#888888">/* 这是一个注释块
  2. 支持
  3. 多行代码 */</span></span></span>

但是你不能在 Python 中做到这一点。

Python 没有任何用于注释多行的内置机制。但是,在 Python 中有不同的方法可以实现这一点。

使用多个标签 (#)

我们可以使用多个主题标签在 Python 中编写多行注释。具有井号 (#) 的每一行都被视为单行注释。

  1. <span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#888888"># 这就是我们如何实现</span>
  2. <span style="color:#888888"># Python 中的多行注释</span>
  3. <span style="color:#397300">打印</span>(<span style="color:#880000">“Hello World”</span>)</span></span>

Python 文档字符串

文档字符串,也称为文档字符串,是用三引号表示的字符串文字,作为模块、函数、类或方法定义中的第一条语句出现。

注意:我们也可以使用三重“””引号来创建文档字符串。

单行文档字符串

让我们举一个例子来演示单行文档字符串。  

  1. <span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#333333"><strong>def </strong></span> <span style="color:#880000"><strong>Add </strong></span>(a,b) :
  2. <span style="color:#880000">'''以两个数字作为输入并返回两个数字之和''' </span>
  3. <span style="color:#333333"><strong>return</strong></span> a+b</span></span>

在三引号内是 函数 Add()的 文档字符串,因为它在其定义之后立即出现。

多行文档字符串

多行文档字符串可以跨越多行代码,以三引号(“””)开头并以三引号(“””)结尾。

以下示例向您展示了如何使用多行文档字符串:

  1. <span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#333333"><strong>def </strong></span> <span style="color:#880000"><strong>Add </strong></span>(a,b) :
  2. <span style="color:#880000">'''取两个数作为输入
  3. 添加 a 和 b
  4. 返回 a 和 b 的总和作为输出
  5. '''</span>
  6. <span style="color:#333333"><strong>返回</strong></span>a+b
  7. 打印(添加(<span style="color:#880000">5</span> , <span style="color:#880000">6</span>))</span></span>