如何在 Python 中註解掉一段程式碼

註釋是使用 Python 時最實用的工具之一。它們 guiding us through the logic, decisions, and purposes behind blocks of code without interfering with execution. 註釋有助於提高 code 的可讀性、可維護性，並有助於在團隊中协作。

本教程將深入介紹 Python 中註釋多行代碼的兩種有效方法，確保您的代碼註釋完善、易於理解。

為什麼 Python 中的區塊註釋很重要？

註釋往往是你在 Python 學習之旅 中遇到的第一个概念。它們為特定的代碼片段提供有用的背景知識。它們提供清晰、具體的資訊，解釋腳本为何要按照某種方式行為。有許多重要的原因可使您在腳本中一直使用註釋。以下是其中的四點：

• 文件：註釋作為文件，解釋函數、類別或代碼块的用途。這對於算法複雜度較高的情況尤為有用，因為 LOGIC may not be immediately apparent.
• 可讀性：好好註釋的代碼更易於閱讀和理解。這對於您或他人在一段時間後重新查看代碼非常重要。
• 除錯：暂时性地註解掉代碼的一部分是隔離和識別錯誤的常見做法。
• 協作：在團隊環境中，註釋使程式碼更易於分享和理解，從而促進更順暢的協作和代碼審查。

在Python中使用單行塊註釋

在我們深入探討如何註釋多行之前，先從單行註釋的基本知識開始。在Python中，單行註釋以井號符號（#）開頭，Python解譯器會忽略該行中井號後的所有內容。要創建單行註釋，請遵循以下步驟：

1. 放置位置：將#符號放在行的開頭或與代碼同一行的代碼後面。註釋可以放在它們描述的代碼上方，與代碼在同一行的右側，或者單獨存在。
2. 內容：在#符號後面，撰寫您的註釋。這可以是對一行代碼的解釋，給未來參考的註記，或與代碼相關的任何有用信息。

# 這是解釋下一行代碼的單行註釋
print("Hello, world!")  # 這將訊息列印到控制台

方法#1：使用多個單行#進行註釋

在Python中加水印的最直接方法是使用#符，它会使跟在其后的所有内容成为注释。雖然Python沒有特定的語法用於块注释，但你可以通過使用多個#符來逐行注释。你只需要執行以下步驟：

1. 標識代碼區塊：首先，標識你希望注解掉的代碼區塊。這可以是函數、循環或你希望禁用或解釋的任何代碼段。
2. 注解每行：在希望你注解掉的每行前面放置一個#符。這告訴Python解釋器在執行時忽略這些行。

你可以看到下面的示例：

# 逐行注解多個行示例
# def example_function(name):
# 	# 這個函數打印"Hello "和輸入的名稱
# 	print("Hello", name)

Python區塊註解方法#2：使用三引號字面量註解

一個用於取消多行註釋的替代方法是使用三引號字符串字面量（”’ ”’ 或 “”” “””）。雖然這不是正式的块註釋，但这些字符串字面量經常用作如此，特別是對於多行註釋或docstrings。要使用三引號字符串，只需將”’或”””放在您希望註釋掉的代碼块前面和后面，如下所示：

'''
def example_function(name):
	print("Hello", name)
'''

三引號字符串字面量最常用于文档化Python函數。例如:

# 創建example_function()
def example_function(name):
	'''
	This function takes as input a name, and returns a salutation to the name in the form of "Hello name"
	'''
	# 打印输出的 
	print("Hello", name)

這些三引號字符串字面量稱為docstrings – 您可以在我們的docstrings教程中了解更多关于它们的信息。