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/
任何語言的程式員，撰寫出符合規范的代碼，是開始程式生涯的第一步
轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/75652.html
標籤：Python