Python 如何添加注释

在Python中，注释是添加到代码中的简短摘要，以使其更易读。程序员在编写代码时使用它们记录他们的思维过程。它解释了为什么首先编写了某行代码。它们只是用来帮助程序员或其他开发人员理解一段代码，特别是因为Python解释器完全忽略注释。

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

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

• 提高可读性。

• 教育他人有关代码。

• 经过一段时间后，您将能够轻松理解代码。

• 资源的引用。

• 重新利用现有代码。

以下是在Python中使用的以井号（#）开头并以空格字符结尾的注释示例。

# This is a comment

示例

以下是一个示例，展示了单行注释的表示形式。

#python program to print “Hello, World!” to console
print("Hello, World!")

输出

在执行以上程序后，会产生以下输出结果。

Hello, World!

块注释

块注释可用于澄清更复杂的代码或读者可能不理解的代码。这些较长的注释与代码的缩进级别相同，并适用于接下来的某些或所有代码。

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

示例

以下示例是一个用于获取当前工作目录路径的Python程序。前四行是程序的说明，并且通过#符号进行了注释。

#Python program to get the path of the current working directory
#Program to get the path of the file
#Using getcwd()
#Importing the os module
import os
print(' The current working directory is: ', os.getcwd())
print('File name is: ', __file__)

输出

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

The current working directory: C:\Users\pranathi\Desktop\python prog
File name: c:\users\pranathi\desktop\python prog\untitled1.py

内联注释

在代码之后，内联注释会出现在与语句相同的行上。它们以井号和一个空格字符开头，与常规注释类似。

示例

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

print("Hello, World!") #python program to print “Hello, World!” to console

输出

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

Hello, World!

Python文档字符串

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

示例

在以下示例中，注释是用三引号表示的。

'''program to print hello world'''
print("Hello, World!")

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

Hello, World!