Python注釋

注釋的作用

使用用自己熟悉的語言眷射,在程序中對某些代碼進行標注說明焚廊,增強程序的可讀性知允。

Python

單行注釋(行注釋)

  • # 開頭,# 右邊的所有東西都被當做說明文字椰弊,而不是真正要執(zhí)行的程序许溅,只起到輔助說明作用。

  • 示例代碼如下:

# 這是一個單行注釋
print("hello world")

為了保證代碼的可讀性秉版,# 后面建議先添加一個空格贤重,然后再編寫相應(yīng)的說明文字。

在代碼后面增加的單行注釋

  • 在程序開發(fā)時清焕,同樣可以使用 # 在代碼的后面增加說明性的文字

  • 但是并蝗,需要注意的是,為了保證代碼的可讀性秸妥,注釋和代碼之間 至少要有 兩個空格

  • 示例代碼如下:

print("hello world")  # 輸出 `hello world`

多行注釋(塊注釋)

  • 如果希望編寫的 注釋信息很多滚停,一行無法顯示,就可以使用多行注釋

  • 要在 Python 程序中使用多行注釋粥惧,可以用 一對 連續(xù)的 三個 引號(單引號雙引號都可以)

  • 示例代碼如下:

"""
這是一個多行注釋

在多行注釋之間键畴,可以寫很多很多的內(nèi)容……
""" 
print("hello world")

什么時候需要使用注釋?

  1. 注釋不是越多越好影晓,對于一目了然的代碼镰吵,不需要添加注釋
  2. 對于 復(fù)雜的操作檩禾,應(yīng)該在操作開始前寫上若干行注釋
  3. 對于 不是一目了然的代碼挂签,應(yīng)在其行尾添加注釋(為了提高可讀性疤祭,注釋應(yīng)該至少離開代碼 2 個空格)
  4. 絕不要描述代碼,假設(shè)閱讀代碼的人比你更懂 Python饵婆,他只是不知道你的代碼要做什么

在一些正規(guī)的開發(fā)團隊勺馆,通常會有 代碼審核 的慣例,就是一個團隊中彼此閱讀對方的代碼

關(guān)于代碼規(guī)范

任何語言的程序員草穆,編寫出符合規(guī)范的代碼,是開始程序生涯的第一步

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末搓译,一起剝皮案震驚了整個濱河市悲柱,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌些己,老刑警劉巖豌鸡,帶你破解...
    沈念sama閱讀 211,123評論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異段标,居然都是意外死亡涯冠,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,031評論 2 384
  • 文/潘曉璐 我一進店門逼庞,熙熙樓的掌柜王于貴愁眉苦臉地迎上來蛇更,“玉大人,你說我怎么就攤上這事赛糟∨扇危” “怎么了?”我有些...
    開封第一講書人閱讀 156,723評論 0 345
  • 文/不壞的土叔 我叫張陵璧南,是天一觀的道長吨瞎。 經(jīng)常有香客問我,道長穆咐,這世上最難降的妖魔是什么颤诀? 我笑而不...
    開封第一講書人閱讀 56,357評論 1 283
  • 正文 為了忘掉前任,我火速辦了婚禮对湃,結(jié)果婚禮上崖叫,老公的妹妹穿的比我還像新娘。我一直安慰自己拍柒,他們只是感情好心傀,可當我...
    茶點故事閱讀 65,412評論 5 384
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著拆讯,像睡著了一般脂男。 火紅的嫁衣襯著肌膚如雪养叛。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,760評論 1 289
  • 那天宰翅,我揣著相機與錄音弃甥,去河邊找鬼。 笑死汁讼,一個胖子當著我的面吹牛淆攻,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播嘿架,決...
    沈念sama閱讀 38,904評論 3 405
  • 文/蒼蘭香墨 我猛地睜開眼瓶珊,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了耸彪?” 一聲冷哼從身側(cè)響起伞芹,我...
    開封第一講書人閱讀 37,672評論 0 266
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎蝉娜,沒想到半個月后唱较,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 44,118評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡蜀肘,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,456評論 2 325
  • 正文 我和宋清朗相戀三年绊汹,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片扮宠。...
    茶點故事閱讀 38,599評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡西乖,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出坛增,到底是詐尸還是另有隱情获雕,我是刑警寧澤,帶...
    沈念sama閱讀 34,264評論 4 328
  • 正文 年R本政府宣布收捣,位于F島的核電站届案,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏罢艾。R本人自食惡果不足惜楣颠,卻給世界環(huán)境...
    茶點故事閱讀 39,857評論 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望咐蚯。 院中可真熱鬧童漩,春花似錦、人聲如沸春锋。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,731評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至侧馅,卻和暖如春危尿,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背馁痴。 一陣腳步聲響...
    開封第一講書人閱讀 31,956評論 1 264
  • 我被黑心中介騙來泰國打工谊娇, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人弥搞。 一個月前我還...
    沈念sama閱讀 46,286評論 2 360
  • 正文 我出身青樓邮绿,卻偏偏與公主長得像渠旁,于是被迫代替她去往敵國和親攀例。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 43,465評論 2 348