前言
學(xué)會向程序中添加必要的注釋,也是很重要的。注釋不僅可以用來解釋程序某些部分的作用和功能(用自然語言描述代碼的功能),在必要時,還可以將代碼臨時移除,是調(diào)試程序的好幫手。
當(dāng)然,添加注釋的最大作用還是提高程序的可讀性!很多時候,筆者寧愿自己寫一個應(yīng)用,也不愿意去改進別人的代碼,沒有合理的注釋是一個重要原因。雖然良好的代碼可自成文擋,但我們永遠也不清楚今后讀這段代碼的人是誰,他是否和你有相同的思路。或者一段時間以后,你自己也不清楚當(dāng)時寫這段代碼的目的了。
總的來說,一旦程序中注釋掉某部分內(nèi)容,則該內(nèi)容將會被 Python 解釋器忽略,換句話說,此部分內(nèi)容將不會被執(zhí)行。
通常而言,合理的代碼注釋應(yīng)該占源代碼的 1/3 左右。Python 語言允許在任何地方插入空字符或注釋,但不能插入到標(biāo)識符和字符串中間。
在 Python 中,通常包括 3 種類型的注釋,分別是單行注釋、多行注釋和中文編碼聲明注釋。
Python單行注釋
Python 中使用井號(‘#')作為單行注釋的符號,語法格式為:
# 注釋內(nèi)容
也就是說,從符號‘#'處開始,直到換行處結(jié)束,此部分內(nèi)容都作為注釋的內(nèi)容,當(dāng)程序執(zhí)行時,這部分內(nèi)容會被忽略。
單行注釋放置的位置,既可以是要注釋代碼的前一行,例如:
#這是一行簡單的注釋 print ("Hello World!")
也可以是注釋代碼的右側(cè),例如:
print ("Hello World!") #這是一行簡單的注釋
基于注釋在程序中所起到的作用,以上兩種方式雖然放置位置不同,但程序的執(zhí)行結(jié)果是相同的,都是輸出“Hello World!”。
Python多行注釋
多行注釋指的是可以一次性注釋程序中多行的內(nèi)容(包含一行)。多行注釋的語法有 2 種,分別是:
''' 使用 3 個單引號分別作為注釋的開頭和結(jié)尾 可以一次性注釋多行內(nèi)容 這里面的內(nèi)容全部是注釋內(nèi)容 '''
或者
""" 使用 3 個雙引號分別作為注釋的開頭和結(jié)尾 可以一次性注釋多行內(nèi)容 這里面的內(nèi)容全部是注釋內(nèi)容 """
多行注釋通常用來為 Python 文件、模塊、類或者函數(shù)等添加版權(quán)、功能描述等信息。需要注意的是,在 Python 中,如果多行注釋標(biāo)記(三單引號或三雙引號)作為語句的一部分出現(xiàn),就不能再將它們視為多行注釋的標(biāo)記,而應(yīng)看做是字符串的標(biāo)志(同雙引號的作用相同),例如:
print('''Hello,World!''')
該語句的執(zhí)行結(jié)果為:Hello,World!。由此可見,Python 解釋器沒有將這里的三個單引號看做是注釋,而是將它們看作是字符串的標(biāo)志。
Python中文編碼聲明注釋
Python 還提供了一種特殊的中文編碼聲明注釋,其主要用來解決 Python 2.x 中不支持直接寫中文的問題。雖然此問題在 Python 3.x 中已經(jīng)不存在啦,但為了規(guī)范編碼,增強代碼的可執(zhí)行性,方便其他程序員及時了解程序所用的編碼,建議初學(xué)者在程序開頭處加上中文編碼聲明注釋。
中文編碼聲明注釋的語法有如下 2 種:
# -*- coding:編碼 -*- 或者 # coding=編碼
語法中的編碼,指的是編寫程序所用的字符編碼類型,比如 UTF-8、GBK 編碼等。另外,在第一種語法中,‘-*-'并沒有實際意義,只是為了美觀才加上去了,因此,第一種語法格式中可以直接將前后的‘-*-'去掉。
舉個例子,如果指定編碼為 UTF-8,則可以使用下面的中文編碼聲明注釋:
# coding:utf-8 或者 # coding=utf-8
注意 ,給代碼添加注釋是是注釋的基本用法,它還有一個更實用的功能,即用來調(diào)試程序。舉個例子,如果你覺得某段代碼可能有問題,可以先把這段代碼注釋起來,讓 Python 解釋器忽略這段代碼,然后運行。如果程序可以正常執(zhí)行,則可以說明錯誤就是由這段代碼引起的;反之,如果依然出現(xiàn)相同的錯誤,則可以說明錯誤不是由這段代碼引起的。
由此可見,在調(diào)試程序時,學(xué)會注釋代碼,可以縮小錯誤所在的范圍,提高調(diào)試程序的效率。
總結(jié)
以上就是這篇文章的全部內(nèi)容了,希望本文的內(nèi)容對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,謝謝大家對腳本之家的支持。
更多文章、技術(shù)交流、商務(wù)合作、聯(lián)系博主
微信掃碼或搜索:z360901061

微信掃一掃加我為好友
QQ號聯(lián)系: 360901061
您的支持是博主寫作最大的動力,如果您喜歡我的文章,感覺我的文章對您有幫助,請用微信掃描下面二維碼支持博主2元、5元、10元、20元等您想捐的金額吧,狠狠點擊下面給點支持吧,站長非常感激您!手機微信長按不能支付解決辦法:請將微信支付二維碼保存到相冊,切換到微信,然后點擊微信右上角掃一掃功能,選擇支付二維碼完成支付。
【本文對您有幫助就好】元
