Python程式碼註釋的用法和意義
01. 註釋的作用
在大多數程式語言中，註釋都是一項很有用的功能。在一些簡單的程式中只包含Python程式碼，但隨著程式越來越大、越來越複雜，就應在其中新增說明，對你解決問題的方法進行大致的闡述。註釋讓你能夠使用熟悉的自然語言在程式中新增說明，增強程式的可讀性。
以下截圖是一份python遊戲的程式碼，仔細觀察沒有一箇中文字，如果這份程式碼相當複雜，閱讀就會變得很困難。
在開發專案期間，你對各個部分如何協同工作了如指掌，但過段時間後，有些細節你可能不記得了。當然，你總是可以通過研究程式碼來確定各個部分的工作原理，但通過編寫註釋，以清晰的自然語言對解決方案進行概述，可節省很多時間。
02. 單行註釋(行註釋)
以 # 開頭，# 後面的內容都會被Python直譯器忽略，全部被當做說明文字，而不是真正要執行的程式，只起到輔助說明作用。
# 這是第一個單行註釋
print("hello python")
- 為了保證程式碼的可讀性，
#後面建議先新增一個空格，然後再編寫相應的說明文字。 - 一般都是在程式碼的上方寫註釋。
- 如果程式碼和註釋都很短的情況下，同樣可以使用
#在程式碼的後面（旁邊）增加說明性的文字。需要注意的是，為了保證程式碼的可讀性，註釋和程式碼之間 至少要有 兩個空格。 - 示例程式碼如下：
print("hello python") # 輸出 `hello python`
03. 多行註釋（塊註釋）
如果希望編寫的 註釋資訊很多，一行無法顯示，就可以使用多行註釋。
要在 Python 程式中使用多行註釋，可以用 一對 連續的 三個 引號(單引號和雙引號都可以)。
示例程式碼如下：
"""
這是一個多行註釋
在多行註釋之間，可以寫很多很多的內容……
"""
print("hello python")
什麼時候需要使用註釋？
- 註釋不是越多越好，對於一目瞭然的程式碼，不需要添加註釋。
- 對於複雜的操作，應該在操作開始前寫上若干行註釋。
- 對於不是一目瞭然的程式碼，應在其行尾添加註釋(為了提高可讀性，註釋應該至少離開程式碼 2 個空格)。
- 絕不要描述程式碼，假設閱讀程式碼的人比你更懂Python，他只是不知道你的程式碼要做什麼。編寫註釋的主要目的是闡述程式碼要做什麼，以及是如何做的。
要成為專業程式設計師或與其他程式設計師合作，就必須編寫有意義的註釋。當前，大多數軟體都是合作編寫的，編寫者可能是同一家公司的多名員工，也可能是眾多致力於同一個開源專案的人員。訓練有素的程式設計師都希望程式碼中包含註釋，因此你最好從現在開始就在程式中新增描述性註釋。作為新手，最值得養成的習慣之一是，在程式碼中編寫清晰、簡潔的註釋。
如果不確定是否要編寫註釋，就問問自己，找到合理的解決方案前，是否考慮了多個解決方案。如果答案是肯定的，就編寫註釋對你的解決方案進行說明吧。相比回過頭去再添加註釋，刪除多餘的註釋要容易得多。
關於程式碼規範
雖然還沒有開始寫程式碼，但是可以收藏起來，時不時看一下，養成規範的程式碼格式，越早越好。
- Python官方提供有一系列 PEP（Python Enhancement Proposals） 文件
- 其中第 8 篇文件專門針對Python的程式碼格式給出了建議，也就是俗稱的PEP8
- 文件地址：https://www.python.org/dev/peps/pep-0008/
- 谷歌有對應的中文文件：http://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/python_style_rules/
任何語言的程式設計師，編寫出符合規範的程式碼，是開始程式生涯的第一步