1渊抄、單行注釋(行注釋)
Python
中使用#
表示單行注釋护桦。單行注釋可以作為單獨(dú)的一行放在被注釋代碼行之上
二庵,也可以放在語(yǔ)句或表達(dá)式之后
催享。
# 這是單行注釋
- 當(dāng)單行注釋作為單獨(dú)的一行放在被注釋代碼行
之上
時(shí)因妙,為了保證代碼的可讀性,建議在#
后面添加一個(gè)空格
炬称,再添加注釋內(nèi)容
玲躯。 - 當(dāng)單行注釋放在語(yǔ)句或表達(dá)式
之后
時(shí)跷车,同樣為了保證代碼的可讀性朽缴,建議注釋
和語(yǔ)句
(或注釋
和表達(dá)式
)之間至少
要有兩個(gè)空格
密强。
2、多行注釋(塊注釋)
當(dāng)注釋內(nèi)容過(guò)多奕扣,導(dǎo)致一行無(wú)法顯示
時(shí)惯豆,就可以使用多行注釋楷兽。Python
中使用三個(gè)單引號(hào)
或三個(gè)雙引號(hào)
表示多行注釋芯杀。
'''
這是使用三個(gè)單引號(hào)的多行注釋
'''
"""
這是使用三個(gè)雙引號(hào)的多行注釋
"""
3瘪匿、注意
-
注釋不是越多越好
棋弥。對(duì)于一目了然的代碼诚欠,不需要添加注釋。 - 對(duì)于
復(fù)雜的操作
尼荆,應(yīng)該在操作開始前
寫上相應(yīng)的注釋。 - 對(duì)于
不是一目了然的代碼
振亮,應(yīng)該在代碼之后
添加注釋坊秸。 - 絕對(duì)
不要描述代碼
褒搔。一般閱讀代碼的人都了解Python
的語(yǔ)法星瘾,只是不知道代碼要干什么
融求。
4算撮、關(guān)于代碼規(guī)范
Python
官方提供有一系列PEP
文檔肮柜,其中第8
篇文檔專門針對(duì)Python
的代碼格式
給出了建議审洞,也就是俗稱的PEP 8
芒澜。PEP 8文檔地址痴晦。