注釋的作用
使用用自己熟悉的語言眷射,在程序中對某些代碼進行標注說明焚廊,增強程序的可讀性知允。
單行注釋(行注釋)
以
#
開頭,#
右邊的所有東西都被當做說明文字椰弊,而不是真正要執(zhí)行的程序许溅,只起到輔助說明作用。示例代碼如下:
# 這是一個單行注釋
print("hello world")
為了保證代碼的可讀性秉版,
#
后面建議先添加一個空格贤重,然后再編寫相應(yīng)的說明文字。
在代碼后面增加的單行注釋
在程序開發(fā)時清焕,同樣可以使用
#
在代碼的后面增加說明性的文字但是并蝗,需要注意的是,為了保證代碼的可讀性秸妥,注釋和代碼之間 至少要有 兩個空格
示例代碼如下:
print("hello world") # 輸出 `hello world`
多行注釋(塊注釋)
如果希望編寫的 注釋信息很多滚停,一行無法顯示,就可以使用多行注釋
要在 Python 程序中使用多行注釋粥惧,可以用 一對 連續(xù)的 三個 引號(單引號和雙引號都可以)
示例代碼如下:
"""
這是一個多行注釋
在多行注釋之間键畴,可以寫很多很多的內(nèi)容……
"""
print("hello world")
什么時候需要使用注釋?
- 注釋不是越多越好影晓,對于一目了然的代碼镰吵,不需要添加注釋
- 對于 復(fù)雜的操作檩禾,應(yīng)該在操作開始前寫上若干行注釋
- 對于 不是一目了然的代碼挂签,應(yīng)在其行尾添加注釋(為了提高可讀性疤祭,注釋應(yīng)該至少離開代碼 2 個空格)
- 絕不要描述代碼,假設(shè)閱讀代碼的人比你更懂 Python饵婆,他只是不知道你的代碼要做什么
在一些正規(guī)的開發(fā)團隊勺馆,通常會有 代碼審核 的慣例,就是一個團隊中彼此閱讀對方的代碼
關(guān)于代碼規(guī)范
-
Python
官方提供有一系列 PEP(Python Enhancement Proposals) 文檔 - 其中第 8 篇文檔專門針對 Python 的代碼格式 給出了建議侨核,也就是俗稱的 PEP 8
- 文檔地址:https://www.python.org/dev/peps/pep-0008/
- 谷歌對應(yīng)的中文文檔:http://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/python_style_rules/
任何語言的程序員草穆,編寫出符合規(guī)范的代碼,是開始程序生涯的第一步