介紹幾個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 中編寫多行註釋的最簡單方式就是每行新增一個註釋。

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

另外一個選項就是使用 docstrings

Docstrings 是一個多行字串，用來對模組，函式，類和方法進行文件化的。

一個 Docstrings 以(""") 開始，可以是 一行或者多行：

"""This is
a multiline
docstring.
"""

Docstrings 不是技術性的註釋。當 Docstrings 在模組，函式，類，或者方法的前面出現的時候，它在位元組碼中結束，並且變成__doc__特殊屬性的物件。

你更應該使用單行註釋。

如果你閱讀 Python 指令碼，你可能注意到第一行以#!字元開始，接著是 Python 直譯器的路徑。

#!/usr/bin/env python3

這一串字串被稱為shebang,它被用來告訴作業系統，應該使用什麼直譯器來解析檔案。指令碼以 shebang 開頭，並且可以在終端中直接執行，而不用在指令碼輸入python。

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

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

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

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

原文地址：