如何在Python中添加注释？

在Python中，注释是简短的摘要，用于将代码更易于阅读。它们被程序员用于记录其在编写代码时的思考过程。它解释了为什么首先编写了某一行代码。它们仅旨在帮助编写代码的人员或其他开发人员理解代码片段，特别是因为Python解释器完全忽略注释。

更多Python相关文章，请阅读：Python 教程

在Python中，注释可以以各种方式使用。

以下是一些重要应用的示例：

• 改进可读性。

• 教给他人有关代码的知识。

• 长时间后，您可以很容易地理解代码。

• 包括资源。

• 重新运用现有代码。

以下是以井号（#）开头，以空格字符结尾的Python注释示例。

#这是一条注释

示例

以下是一个示例，展示单行注释的表示方法。

#python程序打印“Hello，World！”到控制台
print("Hello，World！")

输出

Hello，World！

块注释

块注释可用于澄清更复杂或读者不太可能理解的代码。这些长形注释与代码缩进相同，并适用于一些或所有后续的代码。

块注释中的每一行都以井号和单个空格开头。如果需要使用多个段落，则应使用单个井号的行将它们分开。

示例

以下示例是一个Python程序，用于获取当前工作目录的路径。前4行是程序的解释，并使用#符号进行注释。

#Python程序获取当前工作目录路径
#用于获取文件路径的程序
#使用getcwd()
#导入os模块
import os
print(' 当前工作目录为：', os.getcwd())
print('文件名为：', __file__)

输出

在执行上述程序时，将生成以下输出。

当前工作目录为：C:\Users\pranathi\Desktop\python prog
文件名为：c:\users\pranathi\desktop\python prog\untitled1.py

内联注释

在代码后面，内联注释与语句在同一行上。它们以井号和单个空格字符开头，类似于常规注释。

示例

在以下示例中，显示了内联注释。在print语句旁边出现的注释是内联注释。

print("Hello，World！") #python程序打印“Hello，World！”到控制台

输出

在执行上述程序时，将生成以下输出。

Hello，World！

Python文档字符串

对于模块、方法、函数、对象和类的注释，Python有一个名为docstrings的内置工具。在声明模块、函数、方法或其他对象后，使用三个引号（”或””）编写它们的第一行。如果它不在第一行中使用，解释器将不会将其视为docstring。doc属性也可以用于获取docstrings。

举例

在下面的例子中，注释用三个引号表示。

'''打印Hello World程序'''
print("Hello, World!")

在执行上述程序时，将生成以下输出。

Hello, World!