前言

學(xué)會(huì)向程序中添加必要的注釋?zhuān)彩呛苤匾摹Ｗ⑨尣粌H可以用來(lái)解釋程序某些部分的作用和功能（用自然語(yǔ)言描述代碼的功能），在必要時(shí)，還可以將代碼臨時(shí)移除，是調(diào)試程序的好幫手。

當(dāng)然，添加注釋的最大作用還是提高程序的可讀性！很多時(shí)候，筆者寧愿自己寫(xiě)一個(gè)應(yīng)用，也不愿意去改進(jìn)別人的代碼，沒(méi)有合理的注釋是一個(gè)重要原因。雖然良好的代碼可自成文擋，但我們永遠(yuǎn)也不清楚今后讀這段代碼的人是誰(shuí)，他是否和你有相同的思路?；蛘咭欢螘r(shí)間以后，你自己也不清楚當(dāng)時(shí)寫(xiě)這段代碼的目的了。

總的來(lái)說(shuō)，一旦程序中注釋掉某部分內(nèi)容，則該內(nèi)容將會(huì)被 Python 解釋器忽略，換句話(huà)說(shuō)，此部分內(nèi)容將不會(huì)被執(zhí)行。

通常而言，合理的代碼注釋?xiě)?yīng)該占源代碼的 1/3 左右。Python 語(yǔ)言允許在任何地方插入空字符或注釋?zhuān)荒懿迦氲綐?biāo)識(shí)符和字符串中間。

在 Python 中，通常包括 3 種類(lèi)型的注釋?zhuān)謩e是單行注釋、多行注釋和中文編碼聲明注釋。

Python單行注釋

Python 中使用井號(hào)（‘#'）作為單行注釋的符號(hào)，語(yǔ)法格式為：

# 注釋內(nèi)容

也就是說(shuō)，從符號(hào)‘#'處開(kāi)始，直到換行處結(jié)束，此部分內(nèi)容都作為注釋的內(nèi)容，當(dāng)程序執(zhí)行時(shí)，這部分內(nèi)容會(huì)被忽略。

單行注釋放置的位置，既可以是要注釋代碼的前一行，例如：

#這是一行簡(jiǎn)單的注釋
print ("Hello World!")

也可以是注釋代碼的右側(cè)，例如：

print ("Hello World!") #這是一行簡(jiǎn)單的注釋

基于注釋在程序中所起到的作用，以上兩種方式雖然放置位置不同，但程序的執(zhí)行結(jié)果是相同的，都是輸出“Hello World!”。

Python多行注釋

多行注釋指的是可以一次性注釋程序中多行的內(nèi)容（包含一行）。多行注釋的語(yǔ)法有 2 種，分別是：

'''
使用 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)、功能描述等信息。需要注意的是，在 Python 中，如果多行注釋標(biāo)記（三單引號(hào)或三雙引號(hào)）作為語(yǔ)句的一部分出現(xiàn)，就不能再將它們視為多行注釋的標(biāo)記，而應(yīng)看做是字符串的標(biāo)志（同雙引號(hào)的作用相同），例如：

print('''Hello,World!''')

該語(yǔ)句的執(zhí)行結(jié)果為：Hello，World!。由此可見(jiàn)，Python 解釋器沒(méi)有將這里的三個(gè)單引號(hào)看做是注釋?zhuān)菍⑺鼈兛醋魇亲址臉?biāo)志。

Python中文編碼聲明注釋

Python 還提供了一種特殊的中文編碼聲明注釋?zhuān)渲饕脕?lái)解決 Python 2.x 中不支持直接寫(xiě)中文的問(wèn)題。雖然此問(wèn)題在 Python 3.x 中已經(jīng)不存在啦，但為了規(guī)范編碼，增強(qiáng)代碼的可執(zhí)行性，方便其他程序員及時(shí)了解程序所用的編碼，建議初學(xué)者在程序開(kāi)頭處加上中文編碼聲明注釋。

中文編碼聲明注釋的語(yǔ)法有如下 2 種：

# -*- coding:編碼 -*-
或者
# coding=編碼

語(yǔ)法中的編碼，指的是編寫(xiě)程序所用的字符編碼類(lèi)型，比如 UTF-8、GBK 編碼等。另外，在第一種語(yǔ)法中，‘-*-'并沒(méi)有實(shí)際意義，只是為了美觀(guān)才加上去了，因此，第一種語(yǔ)法格式中可以直接將前后的‘-*-'去掉。

舉個(gè)例子，如果指定編碼為 UTF-8，則可以使用下面的中文編碼聲明注釋?zhuān)?br />

# coding:utf-8
或者
# coding=utf-8

注意，給代碼添加注釋是是注釋的基本用法，它還有一個(gè)更實(shí)用的功能，即用來(lái)調(diào)試程序。舉個(gè)例子，如果你覺(jué)得某段代碼可能有問(wèn)題，可以先把這段代碼注釋起來(lái)，讓 Python 解釋器忽略這段代碼，然后運(yùn)行。如果程序可以正常執(zhí)行，則可以說(shuō)明錯(cuò)誤就是由這段代碼引起的；反之，如果依然出現(xiàn)相同的錯(cuò)誤，則可以說(shuō)明錯(cuò)誤不是由這段代碼引起的。

由此可見(jiàn)，在調(diào)試程序時(shí)，學(xué)會(huì)注釋代碼，可以縮小錯(cuò)誤所在的范圍，提高調(diào)試程序的效率。

總結(jié)

以上就是這篇文章的全部?jī)?nèi)容了，希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，謝謝大家對(duì)腳本之家的支持。

最新評(píng)論