註解 (Comments)
註解是程式碼中不會被電腦執行的部分,核心目的是用來解釋程式邏輯或暫時讓某段程式失效。
註解的目的不是要讓初學者看懂你在幹嘛,而是用來提醒專家和你自己困難邏輯的部分在幹嘛,如果這個功能邏輯較為複雜,或有特殊考量時,就必須要在附近加上註解,但如果是很基礎簡單的部分,就不要再加上註解,否則會增加撰寫程式的時間。詳細的註解規則可參考Python專業社群的PEP8規範。
單行註解
- 符號:使用
#。 - 功能:電腦會忽略
#之後的該行文字。 - 快捷鍵:在 Colab 或 VS Code 中,選取程式碼後按
Ctrl+/可快速切換註解。
多行註解(區塊註解)
符號:使用三個雙引號
"""或三個單引號'''將文字包覆起來。功能:允許文字跨越多行,常當作「區塊註解」使用,或用於暫時停用一大段程式碼。
技術細節:在 Python 的定義中,這其實是「多行字串 (Multi-line String)」。但如果這個字串沒有賦值給任何變數(即沒有寫
text = ...),Python 執行時會讀取它但不會做任何處理,效果等同於註解。範例:
""" 這是一個多行註解的範例 你可以寫很多行 電腦都會略過不執行 """ print("Hello")
在開發專案時,不要把註解當成debug的工具
早期學習程式時,常把除錯當成主要工具:在迴圈中大量 print 資訊,或用快捷鍵反覆註解、取消註解測試程式碼,一邊修改一邊拼出最終版本。當程式規模還在五百行內時,這種方式尚可運作。
但隨著專案複雜度提高,開發週期拉長,多個專案同步進行,中途又可能因瓶頸或突發任務而中斷。幾個月後回頭看程式碼時,混雜其中的大量測試片段與除錯 print ,反而成了干擾理解的雜訊,使維護更加困難。
當註解與臨時測試累積到一定程度,就必須轉向更正規的開發模式。註解應回歸「提示」本質,而非暫時性的測試工具。
針對測試程式碼,建議透過 Git 管理開發歷程。當功能穩定後,可放心清除測試內容,需要時再從舊版本取用即可。至於複雜邏輯的追蹤,則應導入 Log 模組,統一使用 log.debug() 輸出資訊。封裝成執行檔時,只需調高顯示層級,即可隱藏除錯訊息,同時保留錯誤紀錄。
透過這樣的做法,能有效降低註解與臨時輸出的干擾,讓專案維持清晰且可維護的狀態。
歪樓的部分
我之前在寫code壓力大時,曾在我所有的code原始碼中,加入大量的圖像註解,一來是抒發壓力,二來是留一個趣味的東西給後人看,是看到Dcard工程師的code得到的靈感🤣