本文将深入讲解如何在 Python 3 中使用注释。Python 注释是开发过程中非常有用的工具，它们可以提高代码的可读性和可维护性。
什么是 Python 注释？
Python 注释是在源代码中添加的额外文本，解释代码的目的、功能或者注意事项。它们不会被 Python 解释器执行，而是为了方便人类阅读和理解。
Python 有三种注释：
-
单行注释：以
#开头的文本，直到行尾结束。 - 多行注释（文档字符串）：使用三个连续的单引号或双引号包围的文本。通常放在函数、类或模块的定义之后，作为对它们的描述。
- 函数注解（Python 3.5+）：提供关于函数参数和返回值的元数据。
如何使用 Python 注释？
单行注释
单行注释是最常见的注释形式，用来解释下一行代码或者临近的代码片段。例如：
# This is a single line comment
x = 1 # This is an inline comment
多行注释（文档字符串）
多行注释，也被称为“docstrings”，是对函数、类或模块的描述。它们可以使用三个连续的单引号(''')或双引号(""")包围。例如：
def greet(name):
"""This function greets to the person passed in as a parameter.
Args:
name (str): The name of the person to greet.
Returns:
str: A greeting message.
"""
return f"Hello, {name}!"
使用 help(function_name) 可以查看函数的文档字符串。
函数注解（Python 3.5+）
函数注解是 Python 3.5 引入的一种新特性，它允许我们为函数参数和返回值添加元数据。例如：
def greet(name: str) -> str:
return f"Hello, {name}!"
这里，-> str 表示函数的返回类型是一个字符串，而 name: str 表示参数 name 应该是一个字符串。然而，Python 解释器并不会强制执行注解中的类型信息；它们主要是为了方便开发者和工具来理解代码。
最佳实践
- 尽量使用有意义的注释，不要重复写已经明确表达的代码。
- 对于复杂的操作或算法，使用多行注释来解释。
- 对于公共 API（函数、类等），使用文档字符串来描述它们的功能和用法。
- 如果您的代码可能会被其他人阅读或维护，请遵循 PEP 8 风格指南中关于注释的建议。