註釋是代碼的“說明書”,能幫助我們和別人理解代碼的作用,也方便自己以後回顧。Python的註釋語法簡單,但初學者可能會混淆單行和多行註釋的寫法,今天就用簡單的語法搞定它們!
一、單行註釋:最常用的“一句話說明”¶
在Python中,單行註釋用 # 開頭,# 後面的內容會被Python自動忽略,不會執行。
用法示例:
# 這是單行註釋,解釋下面這行代碼的作用
print("Hello, Python!") # 也可以寫在代碼行的右邊,說明代碼功能
# 注意:# 後面的內容纔是註釋,前面的空格不影響
# 但如果#前面有代碼,必須用空格隔開,否則會報錯
關鍵點:
- # 只對它所在行的後續內容生效,不會影響其他行。
- 不要把 # 寫在字符串裏面,比如 print("# Hello") 會輸出 # Hello(# 被當作字符串的一部分)。
二、多行註釋:需要“一大段說明”¶
Python沒有像其他語言(如Java的/* */)那樣的多行註釋語法,但可以用 三個單引號 ''' 或三個雙引號 """ 實現多行註釋。
用法示例:
# 多行註釋:直接用三個單引號,不賦值給變量
'''
這是第一行多行註釋
可以寫很多行內容
解釋一段代碼的作用
比如這裏要說明某個函數的功能
'''
# 也可以用三個雙引號,效果一樣
"""
這是用雙引號的多行註釋
換行內容也會被當作註釋
"""
注意:
- 這種多行註釋本質是“字符串”,如果寫在函數內部,會被當作函數的 文檔字符串(docstring),可以通過 help() 查看,比如:
def greet():
"""
打印一句問候語
"""
print("Hello!")
help(greet) # 調用 help() 會顯示 docstring 內容
但作爲初學者,只需記住:多行註釋用三個引號,不用賦值變量,直接寫在代碼裏即可。
三、註釋的“避坑指南”¶
- 不要用註釋“隱藏”代碼:比如
# print("這段代碼被註釋了")雖然沒執行,但這樣的註釋沒有意義,應該直接刪除或保留真實代碼。 - 避免冗餘註釋:比如
# 這行代碼是打印就沒必要,直接看代碼邏輯更清晰。註釋應解釋“爲什麼這麼寫”,而不是“做了什麼”。 - 多行註釋別和字符串混淆:比如
my_var = '''這是註釋'''會把字符串賦值給my_var,雖然不影響程序運行,但這不是註釋的正確用法,註釋應該直接用三個引號,不賦值變量。
總結¶
Python註釋其實很簡單:
- 單行註釋:用 #,適合解釋單句代碼。
- 多行註釋:用 ''' 或 """,適合大段說明。
記住這兩個語法,就能輕鬆寫出清晰的註釋,讓你的代碼“會說話”!