註解（Comments）是程式編寫中非常重要的一部分，尤其在協作專案或長期維護的程式庫中。它們能幫助開發者記錄邏輯、解釋功能或臨時禁用程式碼。在這篇指南中，我們將探討 Python 中兩種主要的注釋方式：單行注釋與多行注釋。

單行註解 (#)

語法

Python 中的單行註解是用井號符號 (#) 來標示。井號後面的所有文字都會被解譯器忽略。

# This is a single-line comment

範例

以下是使用單行註解的範例：

# This line of code will be ignored
# print("Hello World")

print("Hello")  # You can also add comments after a line of code

輸出

Hello

常見用途：

• 臨時禁用某段程式碼
• 解釋特定行的邏輯
• 添加註解或特別的注意事項

多行註解 (“”” “”” 和 ”’ ”’)

語法

多行註解是使用三重雙引號 (""") 或三重單引號 (''') 來創建的。這些引號中的所有內容都會被解譯器忽略。

"""
This is an example of a multi-line comment.
Each line within the quotes is ignored.
"""

或

'''
This is also a multi-line comment.
The usage is identical to triple double quotes.
'''

範例

以下是使用多行註解的範例：

"""
This block of code will be ignored:
print("Hello World")
"""

print("Hello SaludPCB")  # This line will execute

'''
This block of code will also be ignored:
print("Hello World 1")
print("Hello World 2")
print("Hello World 3")
'''

輸出

Hello SaludPCB

常見用途：

• 註解較大區塊的程式碼或模組功能
• 禁用大量測試程式碼
• 透過詳細解釋來提高程式碼可讀性（不過對於文檔化，建議使用文檔字串）

最佳實踐與技巧

• 避免過度註解：程式碼應該儘量自我解釋，過多的註解會讓程式碼顯得擁擠，降低可讀性。
• 優先清晰：使用簡潔明瞭的註解，提供有價值的解釋。避免重複的解釋。
• 遵循標準：確保註解符合社群規範，例如井號 (#) 後加一個空格（例如：# 這是一個註解），這是 Python 的 PEP 8 中所建議的。
• 適當使用文檔字串：對於需要詳細解釋的函數、類別或模組，應該使用文檔字串（docstrings）來替代註解。

結論

有效的註解使用是乾淨且易於維護程式碼的標誌。掌握 Python 中註解的使用，你可以撰寫不僅功能完整，還能保持可讀性並便於協作的程式碼。無論是解釋複雜邏輯、禁用臨時程式碼，還是文檔化大段功能，了解何時及如何使用單行註解和多行註解都是非常重要的。

在 2025 年及未來，隨著程式開發的演變，遵循清晰簡潔的註解標準仍然是每位 Python 開發者的必要技能。使用這些技巧與方法，你可以提升程式碼的品質，使其更具專業水準。