Python 註解 (Comments)

註解是程式碼中的說明文字，Python 執行時會忽略註解內容。註解的用途是幫助自己或其他開發者理解程式碼的用途和邏輯。

單行註解

使用井字號 # 開頭的文字是單行註解：

# 這是一個單行註解
print("Hello, World!")

name = "Alice"  # 這是行尾註解

Python 沒有專門的多行註解語法，但有兩種常見的做法：

# 這是第一行註解
# 這是第二行註解
# 這是第三行註解
print("Hello!")

用三個引號 ''' 或 """ 包起來的字串，如果沒有指定給變數，Python 會忽略它：

'''
這是多行註解
可以寫很多行
Python 會忽略這段內容
'''
print("Hello!")

"""
這也是多行註解
使用雙引號
"""
print("Hello!")

嚴格來說，三引號是多行字串 (multiline string)，不是真正的註解。但因為沒有指定給變數，所以執行時會被忽略，常被用作多行註解。

Docstring 是一種特殊的註解，用來說明函數、類別或模組的用途。Docstring 放在函數或類別定義的第一行，使用三引號：

def greet(name):
    """
    這個函數用來打招呼
    
    參數:
        name: 要打招呼的對象名稱
    
    回傳:
        打招呼的字串
    """
    return f"Hello, {name}!"

Docstring 可以透過 __doc__ 屬性取得：

print(greet.__doc__)

# 不好的註解
x = x + 1  # x 加 1

# 好的註解
x = x + 1  # 補償邊界條件的偏移量