介紹幾個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 is
a multiline
docstring.
"""

Docstrings 不是技術性的注釋。當 Docstrings 在模塊，函數，類，或者方法的前面出現的時候，它在字節碼中結束，並且變成__doc__特殊屬性的對象。

你更應該使用單行注釋。

三、Shebang

如果你閱讀 Python 腳本，你可能注意到第一行以#!字符開始，接着是 Python 解釋器的路徑。

#!/usr/bin/env python3

這一串字符串被稱為shebang,它被用來告訴操作系統，應該使用什么解釋器來解析文件。腳本以 shebang 開頭，並且可以在終端中直接運行，而不用在腳本輸入python。

因為 shebang 以 井號開頭，它被認為是一個注釋，並且自動被 Python 解釋器忽略。

四、總結

編寫注釋是一個非常好的實踐，它幫助其他開發者，包括未來的自己，來理解這段代碼在做什么。

在 Python 中，所有以井號開頭的直到行末的，都被認為是一段注釋。

以上就是Python 中寫注釋的方法的詳細內容。