在 Python 中，注釋是用于解釋代碼、提高代碼可讀性和可維護性的重要工具。Python 支持兩種主要的注釋方式：單行注釋和多行注釋。此外，Python 還支持文檔字符串（docstrings），用于為模塊、函數、類和方法提供詳細的文檔。

1.?單行注釋

單行注釋使用 # 符號。# 后面的所有內容都會被解釋器忽略。

# 這是一個單行注釋
print("Hello, World!")  # 這是一個注釋

2.?多行注釋

多行注釋可以使用多個 # 符號，或者使用三引號（''' 或 """）。

使用多個?#?符號

# 這是一個多行注釋
# 它可以跨越多行
# 用于解釋復雜的代碼邏輯
print("Hello, World!")

使用三引號

"""
這是一個多行注釋
它也可以跨越多行
并且可以用于文檔字符串
"""
print("Hello, World!")

3.?文檔字符串

文檔字符串是 Python 中的一種特殊注釋，用于為模塊、函數、類和方法提供詳細的文檔。文檔字符串通常使用三引號（''' 或 """）。

模塊文檔字符串

"""
這是一個模塊文檔字符串
它描述了模塊的功能和用途
"""
print("Hello, World!")

函數文檔字符串

def greet(name):"""這是一個函數文檔字符串它描述了函數的功能、參數和返回值:param name: 傳入的名稱:return: 返回一個問候字符串"""return f"Hello, {name}!"print(greet("Alice"))

類文檔字符串

class Person:"""這是一個類文檔字符串它描述了類的功能和用途"""def __init__(self, name, age):self.name = nameself.age = agedef greet(self):return f"Hello, my name is {self.name} and I am {self.age} years old."person1 = Person("Alice", 30)
print(person1.greet())

4.?注釋的最佳實踐

• 簡潔明了：注釋應簡潔明了，避免冗長。

• 解釋復雜邏輯：注釋應解釋復雜的邏輯和算法，而不是顯而易見的代碼。

• 更新注釋：注釋應與代碼同步更新，避免過時的注釋誤導開發者。

• 使用文檔字符串：為模塊、函數、類和方法提供詳細的文檔字符串，便于其他開發者理解和使用。

5.?示例代碼

以下是一個包含各種注釋的示例代碼：

"""
這是一個模塊文檔字符串
它描述了模塊的功能和用途
"""# 導入必要的庫
import mathdef calculate_area(radius):"""這是一個函數文檔字符串它描述了函數的功能、參數和返回值:param radius: 圓的半徑:return: 圓的面積"""# 計算圓的面積area = math.pi * radius ** 2return area# 主函數
def main():# 獲取用戶輸入radius = float(input("請輸入圓的半徑: "))# 調用函數area = calculate_area(radius)# 打印結果print(f"圓的面積是: {area:.2f}")if __name__ == "__main__":main()

通過這些注釋方式，開發者可以有效地提高代碼的可讀性和可維護性。