讀古今文學網 > 父與子的編程之旅:與小卡特一起學Python > 9.4 多行註釋 >

9.4 多行註釋

有時你可能想使用多行註釋。可以使用多行,每行前面都有一個 # 字符,像下面這樣:

# ***************# 這個程序用來說明Python 中如何使用註釋# 星號所在的行只為將註釋# 與其餘代碼清楚地區分開# ***************  

多行註釋可以很好地「突出」代碼段,使你讀代碼時能清楚地區分不同代碼段。可以用多行註釋來描述一段代碼要做什麼。程序最開始的多行註釋可以列出作者的名字、程序名、編寫或更新的日期,以及你認為可能有用的任何其他信息。

三重引號字符串

Python 中還有一種方法可以相當於多行註釋。只需建立一個沒有名字的三重引號字符串。還記得在第 2 章中曾經說過,三重引號字符串是一個可以跨多行的字符串。所以可以這樣寫:

""" 這是一個包括多行的註釋,使用了三重引號字符串。這不完全是註釋,不過也可以相當於註釋。"""  

因為這個字符串沒有名字,而且程序對這個字符串不「做」任何處理,所以它對程序的運行沒有任何影響。它相當於一個註釋,儘管從嚴格的 Python 術語來講這並不是一個真正的註釋。

像(Python)程序員一樣思考

有些 Python 程序員認為不應該使用三重引號字符串(多行字符串)作為註釋。就我個人來說,我看不出這有什麼充分的理由。加註釋的目的就是讓你的代碼更易讀、更容易理解。如果你覺得三重引號字符串很方便,可能會更願意在代碼中加入註釋,這畢竟是件好事。

如果在 IDLE 編輯器鍵入一些註釋,可以看到註釋會用不同的顏色顯示。這是為了幫助你更容易地讀代碼。

大多數代碼編輯器允許你改變註釋的顏色(或者可以改變代碼其他部分的顏色)。IDLE 中註釋的默認顏色是紅色。因為三重引號字符串不是真正的 Python 註釋,它們的顏色會不同。在 IDLE 中三重引號字符串是綠色,因為綠色是 IDLE 中字符串的默認顏色。