《像計算機科學家一樣思考Python（第2版）》——2.7 注釋

本節書摘來自異步社群《像計算機科學家一樣思考python（第2版）》一書中的第2章，第2.7節，作者[美] allen b. downey，趙普明 譯，更多章節内容可以通路雲栖社群“異步社群”公衆号檢視。

當程式變得更大更複雜時，讀起來也更困難。形式語言很緊湊，經常會遇到一段代碼，卻很難弄清它在做什麼、為什麼那麼做。

是以，在程式中加入自然語言的筆記來解釋程式在做什麼，是個好主意。這種筆記被稱為注釋（comments），它們以#開頭：

在這個例子裡，注釋單獨占據一行。也可以把注釋放到代碼行的結尾：

<code>percentage = (minute * 100) / 60 # percentage of an hour</code>

從#開始到行尾的注釋内容都會被解釋器忽略掉—它們對程式本身運作沒有任何影響。

注釋最重要的用途在于解釋代碼并不顯而易見的特性。我們可以合理地認為讀者可以看懂代碼在做什麼，是以使用注釋來解釋為什麼這麼做，要有用得多。

下面這段注釋與代碼重複，毫無用處：

而下面這段注釋則包含了代碼中看不到的有用資訊：

選擇好的變量名稱，可以減少注釋的需要，但長名字也會讓複雜表達式更難閱讀，是以這兩者之間需要衡量舍取。