Python 速查手冊

1.2 註解

註解 (comment) 如其字面意義,就是附加的說明文字,為什麼程式 (program) 需要註解呢?因為有時候自己會忘了為什麼自己要這樣寫程式碼 (code) ,又或者程式碼需要跟其他人共同合作開發,為了確保團隊中的每個人都能理解特定程式碼的用途,因此整個團隊需要一致性的註解方式。總之,註解是為了附加說明,所有在程式中的註解都不會被直譯器 (interpreter) 執行。

Python 的註解方式採用 Perl-Style ,也就是井字號後面接的文字都是註解內容,這些註解內容會被直譯器忽略,直譯器在執行程式的時候會主動跳過註解,直接找註解之後的陳述 (statement) 繼續執行。單行註解如下

#這是註解
#第二行註解

註解也可以放在程式碼之後,例如

pass #這是註解

在不同的文字編輯器 (text editor) 或整合開發環境 (integrated development environment) ,註解會有不同的語法高亮度,例如此圖為 Xcode , Xcode 把註解標為綠色,這裡也可以看到註解的方式,如第一行為單獨一行的註解,第二行則是程式碼之後的註解

註解化是很好用的程式設計技巧,例如此圖將第三行註解化之後,變數 i 的值就不會加上 10 ,因此變數 i 的值不會改變,第四行用 print() 函數仍會印出整數 5 來。註解化通常會用在除錯上,除錯的目的是為了找出錯誤,註解化可強迫某行或某段程式碼不發生作用,因此可觀察其他沒有註解化的程式碼是否會發生錯誤。

上一頁: 1.1 標記
Python 速查手冊 - 目錄
下一頁: 1.3 文件字串
回 Python 教材首頁