Python注释

在 Python 中，注释是源代码中解释器在程序执行期间会忽略的行。这些是程序员可读的解释或注解，添加到代码中，目的是为了让人更容易理解。注释可以提高代码的可读性，有助于调试，并为未来的开发人员提供文档。

让我们看一个简单的例子，说明注释在 Python 中的工作原理。

输出

Welcome to Tpoint Tech to learn Python

说明

在此示例中，我们使用哈希 '#' 符号添加了注释。我们还可以看到 Python 解释器在程序执行期间忽略了注释部分。

Python 中的注释类型

Python 中主要使用三种类型的注释，如下所示：

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

让我们通过示例来讨论这些类型。

单行注释

在 Python 中，单行注释以哈希 '#' 符号开头，Python 会忽略它。单行注释用于对代码提供简短的解释或笔记。

让我们看一个 Python 中单行注释的简单示例。

输出

Welcome to Tpoint Tech!

说明

在上例中，我们使用哈希 '#' 符号添加了一个单行注释。因此，Python 解释器忽略了这一行代码，并执行下一行代码来打印一条语句。

行内注释

行内注释是一种单行注释，出现在语句的同一行，用于解释该行的特定部分。

这是 Python 中行内注释的一个示例。

输出

Welcome to Tpoint Tech!

说明

在上例中，我们在 print() 函数后使用哈希 '#' 符号添加了一个行内注释。Python 解释器忽略了代码行中的注释部分。

多行注释

与其他编程语言（如 C、C++ 和 Java）不同，Python 没有专门的多行注释写法。

但是，可以使用以下方法达到类似的效果：

多个单行注释

向源代码添加多行注释的基本方法之一是在每一行使用哈希符号 '#' 来堆叠单行注释。

请看以下示例，使用多个哈希符号编写多行注释。

输出

Welcome to Tpoint Tech!

说明

在这里，多个单行注释堆叠在一起，使其看起来像一个多行注释。

使用三引号字符串

我们可以使用三引号字符串（''' 或 """) 在 Python 中模拟多行注释。虽然它们在技术上是多行字符串，但我们可以将它们用作注释。

这是一个简单的例子，展示了如何使用三引号字符串向代码添加多行注释。

输出

Welcome to Tpoint Tech!

说明

虽然三引号在技术上不是注释，但在上面的例子中，我们将其用作注释，用于快速记录或调试。

文档字符串

Docstrings（文档字符串）是 Python 中特殊的、可以用于为函数、类、方法和模块编写文档的多行字符串。

与普通注释不同，docstrings 在运行时会被存储。我们可以使用内置的 help() 函数或 __doc__ 属性来访问它们。这使得它们在构建文档齐全、易于维护的代码方面非常有用。

这是一个简单的例子，用于理解 Python 中 docstrings 的工作原理。

输出

Hello, John!, Welcome to Tpoint Tech.
Docstring: 
  This function prints a 
  welcome message for the user

说明

在此，docstring 在运行时存储在内存中。当我们调用 __doc__ 属性时，会返回存储的 docstring。

编写注释的最佳实践

以下是一些可以遵循的技巧，以使注释更有效：

1. 代码应该是自解释的。建议编写注释来解释为什么某些操作以特定方式进行。
2. 始终保持注释简洁、切题且易于扫描。
3. 过时的注释可能会产生误导和危害。因此，如果在代码中进行任何更改，最好更新或删除注释。
4. 使用正确的语法和大小写，使注释更专业，更容易阅读。
5. PEP 8 建议行内注释在哈希 '#' 符号前至少有两个空格。因此，建议遵循 PEP 8 的间距规则。

结论

在 Python 中，注释是一项重要的技能，因为它可以提高代码的可读性和可维护性。无论我们是编写简单的脚本还是开发复杂的应用程序，清晰有意义的注释都能使代码更专业，更容易理解。在本教程中，我们学习了如何在 Python 程序中添加注释。我们还通过各种示例讨论了 Python 中不同类型的注释。

Python 注释 - 常见问题解答

1. 如何在 Python 中编写注释？

我们可以使用哈希 '#' 符号来编写注释，如下所示：

语法

Python 解释器会忽略哈希 '#' 符号之后该行中的所有内容。

2. 注释和 docstring 之间有什么区别？

• 注释：使用哈希 '#' 符号将注释添加到代码中。Python 会忽略注释，并且不会将其存储在内存中。
• Docstring：Docstrings 使用三引号（''' 或 """）添加到代码中，并作为元数据存储。我们可以使用 help() 或 __doc__ 来访问 docstrings。

3. 可以在 Python 中编写多行注释吗？

Python 没有官方的多行注释语法；但是，我们可以：

• 在多行上使用 #
• 使用三引号字符串（''' 或 """）

4. 注释会影响 Python 代码性能吗？

Python 解释器会完全忽略注释，并且不会影响执行速度或内存使用（除非我们使用 docstrings 之外的三引号字符串）。

5. Python 程序中需要注释吗？

严格来说不是；但是，强烈建议在 Python 程序中使用注释。良好的注释可以使代码更容易理解、维护和调试。