![](../../img/interpret.jpg)
Python 簡易手冊
單元 3 - 註解
Python 的註解 (comment) 採用井字號 # 開頭,凡是井字號之後的部分都是註解,直譯器 (interpreter) 會直接忽略不去執行。例如 hello.py 最底下有五行程式碼版權的註解
3 4 5 6 7 | # 檔名: hello.py # 說明: 《Python簡易手冊》的範例 # 網址: http://kaiching.org # 作者: Kaiching Chang # 時間: 2024 年 2 月 |
注意註解只是說明文字,程式碼 (code) 要採用怎麼樣的註解模式,或是針對哪些程式碼做註解,哪些程式碼不做註解,這全由開發團隊決定,也就是說,不同的開發團隊可能會有不同的註解風格。本書的註解以說明程式碼為主,例如 hello2.py 的第一行就說明第二行程式碼的用途
1 2 | # 要求輸入暱稱 name = input("請輸入暱稱 ") |
註解除了可以放在單行的開頭,也可以放在程式碼的之後,例如
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | # 單行註解 a: str # 變數 a 被標記為字串 # 第二行註解 # 將變數 a 指派為字串 a = "# 字串中的井字號不是註解" # 印出變數 a print(a) # 檔名: comment_demo.py # 說明: 《Python簡易手冊》的範例 # 網址: http://kaiching.org # 作者: Kaiching Chang # 時間: 2024 年 2 月 |
第 2 行,註解放在型態標記 (type hint) 的程式碼之後,說明這是對變數 a 做型態標記
2
| a: str # 變數 a 被標記為字串 |
型態標記僅是型態標記僅是標記變數是哪一種型態 (type) ,輔助程式設計師管理變數,目前 Python 直譯器並沒有限制做型態標記的變數一定要被設定為被標記的型態,型態標記會在單元 9 - 型態標記詳細介紹。
下一行同樣是單行註解,但是井字號並沒有放到開頭,而是跟上一行井字號對齊,這是方便閱讀程式碼的排版方式
3
| # 第二行註解
|
此外要注意字串中的井字號屬於字串 (string) 內容, Python 直譯器不會把字串內容當註解
6
| a = "# 字串中的井字號不是註解" |
Python 中單引號 ' 或雙引號 " 圍起來的內容都是字串,有關字串會在單元 33 - 字串詳細介紹。
參考資料
![](../../img/pydoing.gif)