python注释可以辅助程序调试吗_Python 注释
注釋(Comments)用來(lái)向用戶提示或解釋某些代碼的作用和功能,它可以出現(xiàn)在代碼中的任何位置。Python?解釋器在執(zhí)行代碼時(shí)會(huì)忽略注釋,不做任何處理,就好像它不存在一樣。
在調(diào)試(Debug)程序的過(guò)程中,注釋還可以用來(lái)臨時(shí)移除無(wú)用的代碼。直線電機(jī)廠家
注釋的最大作用是提高程序的可讀性,沒(méi)有注釋的程序簡(jiǎn)直就是天書(shū),讓人吐血!
千萬(wàn)不要認(rèn)為你自己寫(xiě)的代碼規(guī)范就可以不加注釋,甩給別人一段沒(méi)有注釋的代碼是對(duì)別人的不尊重,是非常自私的行為;你可以喜歡自虐,但請(qǐng)不要虐待別人。
很多程序員寧愿自己去開(kāi)發(fā)一個(gè)應(yīng)用,也不愿意去修改別人的代碼,沒(méi)有合理的注釋是一個(gè)重要的原因。雖然良好的代碼可以自成文擋,但我們永遠(yuǎn)不清楚今后閱讀這段代碼的人是誰(shuí),他是否和你有相同的思路;或者一段時(shí)間以后,你自己也不清楚當(dāng)時(shí)寫(xiě)這段代碼的目的了。
一般情況下,合理的代碼注釋?xiě)?yīng)該占源代碼的 1/3 左右。
Python 支持兩種類(lèi)型的注釋,分別是單行注釋和多行注釋。
Python 單行注釋
Python 使用井號(hào)#作為單行注釋的符號(hào),語(yǔ)法格式為:
# 注釋內(nèi)容
從井號(hào)#開(kāi)始,直到這行結(jié)束為止的所有內(nèi)容都是注釋。Python 解釋器遇到#時(shí),會(huì)忽略它后面的整行內(nèi)容。
說(shuō)明多行代碼的功能時(shí)一般將注釋放在代碼的上一行,例如:
#使用print輸出字符串
print("Hello World!")
print("C語(yǔ)言中文網(wǎng)")
print("http://c.biancheng.net/python/")
#使用 print輸出數(shù)字
print(100)
print( 3 + 100 * 2)
print( (3 + 100) * 2 )
說(shuō)明單行代碼的功能時(shí)一般將注釋放在代碼的右側(cè),例如:
print("http://c.biancheng.net/python/") #輸出Python教程的地址
print( 36.7 * 14.5 ) #輸出乘積
print( 100 % 7 ) #輸出余數(shù)
Python 多行注釋
多行注釋指的是一次性注釋程序中多行的內(nèi)容(包含一行)。
Python 使用三個(gè)連續(xù)的單引號(hào)'''或者三個(gè)連續(xù)的雙引號(hào)"""注釋多行內(nèi)容,具體格式如下:
'''
使用 3 個(gè)單引號(hào)分別作為注釋的開(kāi)頭和結(jié)尾
可以一次性注釋多行內(nèi)容
這里面的內(nèi)容全部是注釋內(nèi)容
'''
或者
"""
使用 3 個(gè)雙引號(hào)分別作為注釋的開(kāi)頭和結(jié)尾
可以一次性注釋多行內(nèi)容
這里面的內(nèi)容全部是注釋內(nèi)容
"""
多行注釋通常用來(lái)為 Python 文件、模塊、類(lèi)或者函數(shù)等添加版權(quán)或者功能描述信息。
注意事項(xiàng)
1) Python 多行注釋不支持嵌套,所以下面的寫(xiě)法是錯(cuò)誤的:
'''
外層注釋
'''
內(nèi)層注釋
'''
'''
2) 不管是多行注釋還是單行注釋,當(dāng)注釋符作為字符串的一部分出現(xiàn)時(shí),就不能再將它們視為注釋標(biāo)記,而應(yīng)該看做正常代碼的一部分,例如:
print('''Hello,World!''')
print("""http://c.biancheng.net/cplus/""")
print("#是單行注釋的開(kāi)始")
運(yùn)行結(jié)果:
Hello,World!
http://c.biancheng.net/cplus/
#是單行注釋的開(kāi)始
對(duì)于前兩行代碼,Python 沒(méi)有將這里的三個(gè)引號(hào)看作是多行注釋,而是將它們看作字符串的開(kāi)始和結(jié)束標(biāo)志。
對(duì)于第 3 行代碼,Python 也沒(méi)有將井號(hào)看作單行注釋,而是將它看作字符串的一部分。
注釋可以幫助調(diào)試程序
給代碼添加說(shuō)明是注釋的基本作用,除此以外它還有另外一個(gè)實(shí)用的功能,就是用來(lái)調(diào)試程序。
舉個(gè)例子,如果你覺(jué)得某段代碼可能有問(wèn)題,可以先把這段代碼注釋起來(lái),讓 Python 解釋器忽略這段代碼,然后再運(yùn)行。如果程序可以正常執(zhí)行,則可以說(shuō)明錯(cuò)誤就是由這段代碼引起的;反之,如果依然出現(xiàn)相同的錯(cuò)誤,則可以說(shuō)明錯(cuò)誤不是由這段代碼引起的。
在調(diào)試程序的過(guò)程中使用注釋可以縮小錯(cuò)誤所在的范圍,提高調(diào)試程序的效率。
與50位技術(shù)專(zhuān)家面對(duì)面20年技術(shù)見(jiàn)證,附贈(zèng)技術(shù)全景圖總結(jié)
以上是生活随笔為你收集整理的python注释可以辅助程序调试吗_Python 注释的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問(wèn)題。
- 上一篇: python 福利彩票_使用Python
- 下一篇: websocket python爬虫_p