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

9.5 註釋風格

現在你已經知道了如何加註釋。但是應該向註釋裡放什麼內容呢?因為它們並不影響程序如何運行,我們說註釋只是一個「風格」問題。這說明,可以在註釋中放你想放的任何東西(也可以根本不使用註釋)。不過這並不表示註釋不重要。大多數程序員都是費了一番周折才領悟到這一點。他們回頭看幾年前、幾個月前或者是幾個星期前,甚至只是昨天才寫的程序時,可能完全看不明白,這往往因為他們沒有加入足夠的註釋來解釋程序是如何工作的。此時他們就會深深體會到註釋的重要性!儘管寫程序時很明白,但是等以後再看程序時,很可能對原先的想法一頭霧水。

至於應該在註釋中放什麼內容並沒有嚴格的規定,不過建議你盡可能增加註釋。現在看來,註釋越多越好。寧可過於謹慎註釋過多,也比註釋過少要好。積累更多的編程經驗後,你就會慢慢瞭解加多少註釋以及加哪種註釋最適合了。

本書中的註釋

在你手上的這本書中,你可能看不到代碼清單中有多少註釋。這是因為這本書使用了「註解」,也就是代碼旁邊的說明。不過如果查看 \examples 文件夾中或者網站上的代碼清單,你會看到所有代碼中都有註釋。