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/
任何語言的程序員,編寫出符合規范的代碼,是開始程序生涯的第一步