介绍几个Python中写注释的方法

导读这篇⽂章主要介绍了如何在 Python 中注释，帮助其他开发者理解你的代码，以及代码的⽬的。感兴趣的朋友可以了解下

在写 Python 代码的时候，⼀个很好的编码实践就是使得你的代码简洁，易懂。组织代码，设置变量，以及给函数有意义的名字，都是⼏个不错的⽅法。

另外⼀个提⾼代码可读性的⽅式就是使⽤注释。⼀个注释就是可以⽤来解释代码的⼀段⼈类可读的解释或者⼀个注解。例如，如果你写了⼀个复杂的正则表达式，你可以添加⼀个注释，描述代码做了什么。

在你的 Python 代码中添加注释，在将来你阅读你的代码时，可以节省很多的时间和努⼒。⽐如说，你想修改⼀段你在⼏个⽉前或者⼏年前写的。很可能你不记得为什么你写了⼀些⽐较复杂的代码，除⾮你添加⼀段注释。这个注释同时也可以帮助其他开发者理解你的代码，以及代码的⽬的。

注释应该很短，并且切中要点。不要解释那些很容易读懂的代码。本⽂主要讲解在 Python 中编写注释的基础知识。⼀、在 Python 中写注释

Python 会忽略井号(#)后⾯的⼀切。

注释可以添加到⾏⾸或者和其他代码在⼀⾏。

# This is a Python comment.

print(\"Hello World\") # This is an inline Python comment.

井号后⾯的空格不是强制性的，但是它会提⾼注释的可读性。

在字符串中间的井号并不意味着是⼀段注释的开始。此时，它仅仅是⼀个简单的井号。

paragraph = \"# Hash inside quotes is not a comment.\"

Comments should be at the same indent level as the code beneath it: ```py

def factorial(n): if n == 0: return 1 else:

# Use the factorial function return n * factorial(n-1)

如果你的⽂本编辑器⽀持语法⾼亮，注释通常都使⽤绿⾊代表。

注释在调试的时候⾮常有⽤。与其删除⼀些⾏或者代码块，不如将他们暂时注释掉：

# for fruit in fruits:# print(fruit)

⼆、Python 中的多⾏注释(注释块)

不像其他流⾏的编程语⾔，Python 仅仅⽀持单⾏注释。

在 Python 中编写多⾏注释的最简单⽅式就是每⾏添加⼀个注释。

# This is the first line.# This is the second line.

另外⼀个选项就是使⽤ docstrings

Docstrings 是⼀个多⾏字符串，⽤来对模块，函数，类和⽅法进⾏⽂档化的。⼀个 Docstrings 以(\"\"\") 开始，可以是 ⼀⾏或者多⾏：

\"\"\"This isa multilinedocstring.\"\"\"

Docstrings 不是技术性的注释。当 Docstrings 在模块，函数，类，或者⽅法的前⾯出现的时候，它在字节码中结束，并且变成__doc__特殊属性的对象。

你更应该使⽤单⾏注释。三、Shebang

如果你阅读 Python 脚本，你可能注意到第⼀⾏以#!字符开始，接着是 Python 解释器的路径。

#!/usr/bin/env python3

这⼀串字符串被称为shebang,它被⽤来告诉操作系统，应该使⽤什么解释器来解析⽂件。脚本以 shebang 开头，并且可以在终端中直接运⾏，⽽不⽤在脚本输⼊python。

因为 shebang 以 井号开头，它被认为是⼀个注释，并且⾃动被 Python 解释器忽略。四、总结

编写注释是⼀个⾮常好的实践，它帮助其他开发者，包括未来的⾃⼰，来理解这段代码在做什么。在 Python 中，所有以井号开头的直到⾏末的，都被认为是⼀段注释。以上就是Python 中写注释的⽅法的详细内容。