如何對(duì)python代碼進(jìn)行注釋

1、Python 中單行注釋以 # 開(kāi)頭

企業(yè)建站必須是能夠以充分展現(xiàn)企業(yè)形象為主要目的，是企業(yè)文化與產(chǎn)品對(duì)外擴(kuò)展宣傳的重要窗口，一個(gè)合格的網(wǎng)站不僅僅能為公司帶來(lái)巨大的互聯(lián)網(wǎng)上的收集和信息發(fā)布平臺(tái)，成都創(chuàng)新互聯(lián)公司面向各種領(lǐng)域：成都廣告設(shè)計(jì)等網(wǎng)站設(shè)計(jì)、成都全網(wǎng)營(yíng)銷(xiāo)解決方案、網(wǎng)站設(shè)計(jì)等建站排名服務(wù)。

例如：

# 這是個(gè)注釋

print("Hello, World!")

或者：

print("Hello, World!") # 這是個(gè)注釋?zhuān)旁谝恍械淖詈?/p>

2、多行注釋用三個(gè)單引號(hào) ''' 或者三個(gè)雙引號(hào) """ 將注釋括起來(lái)

例如：

'''

這是多行注釋

這是多行注釋

'''

print("Hello, World!")

或者：

"""

這是多行注釋

這是多行注釋

"""

Python 語(yǔ)句和注釋

我們將在本節(jié)中介紹 Python 語(yǔ)句，縮進(jìn)以及注釋?zhuān)诒竟?jié)的最后一部分，還會(huì)介紹作為一種特殊類(lèi)型的 Python 注釋 Docstring 。

Python 語(yǔ)句是給解釋器執(zhí)行的指令，一條 Python 語(yǔ)句包含類(lèi)似于如下的表達(dá)式，

你可以將 Python 語(yǔ)句堪稱(chēng)解釋器解釋表達(dá)式并將其結(jié)果存儲(chǔ)在變量中的指令。類(lèi)似于 for , while , print 之類(lèi)的語(yǔ)句具有特殊的含義，我們將在在后面的章節(jié)中討論。

當(dāng)你在一句語(yǔ)句結(jié)束時(shí)按回車(chē)鍵后，該 Python 語(yǔ)句被終止，我們可稱(chēng)之為單行語(yǔ)句。Python 中的多行語(yǔ)句可以通過(guò)使用連續(xù)字符 來(lái)創(chuàng)建，它將 Python 語(yǔ)句擴(kuò)展為多行語(yǔ)句。

比如下面的例子，

這可以被稱(chēng)作明確的多行接續(xù)。

你還可以使用括號(hào) () ，方括號(hào) [] 或大括號(hào) {} 來(lái)進(jìn)行隱式的多行接續(xù)。

例如，你可以使用括號(hào)來(lái)連接多行語(yǔ)句，

Python 語(yǔ)句塊，例如函數(shù)，循環(huán)或類(lèi)的主體，以縮進(jìn)來(lái)開(kāi)頭。對(duì)于語(yǔ)句塊內(nèi)的每個(gè)語(yǔ)句，應(yīng)該保持相同的縮進(jìn)。當(dāng)縮進(jìn)不一致時(shí)，你將得到什么什么 IndentationError 。

一般來(lái)說(shuō)，在

Python 代碼樣式指南

中建議使用 4 個(gè)縮進(jìn)空格。舉例如下，

我們用縮進(jìn)來(lái)增加程序的可讀性，比如在下面的程序中，我們用兩種方式來(lái)完成同一個(gè)功能，

你可以在這里看到第一個(gè)例子比第二個(gè)例子有更好的可讀性。

注釋用于描述程序的目的或工作工程，注釋是在 Python 解釋過(guò)程中被忽略的行為，它們不會(huì)干擾程序的流程。

如果你正在編寫(xiě)數(shù)百行代碼，肯定需要添加注釋?zhuān)驗(yàn)槠渌嗽陂喿x你的代碼的時(shí)候，沒(méi)有足夠的時(shí)間閱讀每一行來(lái)理解代碼的工作。程序的注釋增加了可讀性，并解釋了代碼的工作原理。

Python 注釋以井號(hào) # 開(kāi)始

Using hash symbol in each line can define a multi-line comment. But there is another way to add a multi-line comment in Python, that is using triple quotation marks. You can use either ''' or """ .

三重引號(hào) ''' 通常可以用來(lái)定義多行文檔注釋 Docstring ，你也可以用它來(lái)作為另外一種在 Python 中添加多行注釋的方法。

Docstring 是文檔字符串，它通常是 Python 函數(shù)，類(lèi)，模塊等的第一條語(yǔ)句。函數(shù)，方法和類(lèi)的描述和注釋位于文檔字符串（文檔字符串）內(nèi)。

舉例如下，

一目了然， Docstring 介紹了函數(shù)的功能。

Python有哪幾種注釋方式

python中的注釋有單行注釋和多行注釋?zhuān)?/p>

1、單行注釋(行注釋)

python中使用#表示單行注釋。單行注釋可以作為單獨(dú)的一行放在被注釋代碼行之上，也可以放在語(yǔ)句或表達(dá)式之后。

比如：

# 這是一個(gè)注釋

print("Hello, World!")

①當(dāng)單行注釋作為單獨(dú)的一行放在被注釋代碼行之上時(shí)，為了保證代碼的可讀性，建議在#后面添加一個(gè)空格，再添加注釋內(nèi)容。

②當(dāng)單行注釋放在語(yǔ)句或者表達(dá)式之后時(shí)，同樣為了保證代碼的可讀性，建議注釋和語(yǔ)句之間至少要有兩個(gè)空格。

2、多行注釋(塊注釋)

當(dāng)注釋內(nèi)容過(guò)多，導(dǎo)致一行無(wú)法顯示時(shí)，就可以使用多行注釋。多行注釋用三個(gè)單引號(hào)'''或者三個(gè)雙引號(hào) """將注釋括起來(lái)。

①單引號(hào)(''')

'''

這是多行注釋?zhuān)萌齻€(gè)單引號(hào)

這是多行注釋?zhuān)萌齻€(gè)單引號(hào)

這是多行注釋?zhuān)萌齻€(gè)單引號(hào)

'''

print("Hello, World!")

②雙引號(hào)(""")

"""

這是多行注釋?zhuān)萌齻€(gè)雙引號(hào)

這是多行注釋?zhuān)萌齻€(gè)雙引號(hào)

這是多行注釋?zhuān)萌齻€(gè)雙引號(hào)

"""

print("Hello, World!")

3、注意

①注釋不是越多越好，對(duì)于一目了然的代碼，不需要添加注釋;

②對(duì)于復(fù)雜的操作，應(yīng)該在操作開(kāi)始前寫(xiě)上相應(yīng)的注釋;

③對(duì)于不是一目了然的代碼，可以在代碼之后添加注釋;

④絕對(duì)不要描述代碼，一般閱讀代碼的人都了解python的語(yǔ)法，只是不知道代碼要干什么。

python中函數(shù)定義

1、函數(shù)定義

①使用def關(guān)鍵字定義函數(shù)

②

def 函數(shù)名(參數(shù)1.參數(shù)2.參數(shù)3...):

"""文檔字符串，docstring，用來(lái)說(shuō)明函數(shù)的作用"""

#函數(shù)體

return 表達(dá)式

注釋的作用：說(shuō)明函數(shù)是做什么的，函數(shù)有什么功能。

③遇到冒號(hào)要縮進(jìn)，冒號(hào)后面所有的縮進(jìn)的代碼塊構(gòu)成了函數(shù)體，描述了函數(shù)是做什么的，即函數(shù)的功能是什么。Python函數(shù)的本質(zhì)與數(shù)學(xué)中的函數(shù)的本質(zhì)是一致的。

2、函數(shù)調(diào)用

①函數(shù)必須先定義，才能調(diào)用，否則會(huì)報(bào)錯(cuò)。

②無(wú)參數(shù)時(shí)函數(shù)的調(diào)用：函數(shù)名()，有參數(shù)時(shí)函數(shù)的調(diào)用：函數(shù)名(參數(shù)1.參數(shù)2.……)

③不要在定義函數(shù)的時(shí)候在函數(shù)體里面調(diào)用本身，否則會(huì)出不來(lái)，陷入循環(huán)調(diào)用。

④函數(shù)需要調(diào)用函數(shù)體才會(huì)被執(zhí)行，單純的只是定義函數(shù)是不會(huì)被執(zhí)行的。

⑤Debug工具中Step into進(jìn)入到調(diào)用的函數(shù)里，Step Into My Code進(jìn)入到調(diào)用的模塊里函數(shù)。

python代碼的注釋有幾種

python代碼的注釋有兩種。

一、python單行注釋符號(hào)(#)

python中單行注釋采用#開(kāi)頭，示例：#thisisacomment。

二、批量、多行注釋符號(hào)

多行注釋是用三引號(hào)，例如：輸入''''''或者""""，將要注釋的代碼插在中間。

Python由荷蘭數(shù)學(xué)和計(jì)算機(jī)科學(xué)研究學(xué)會(huì)的吉多·范羅蘇姆于1990年代初設(shè)計(jì)，作為一門(mén)叫做ABC語(yǔ)言的替代品。Python提供了高效的高級(jí)數(shù)據(jù)結(jié)構(gòu)，還能簡(jiǎn)單有效地面向?qū)ο缶幊獭?/p>

Python語(yǔ)法和動(dòng)態(tài)類(lèi)型，以及解釋型語(yǔ)言的本質(zhì)，使它成為多數(shù)平臺(tái)上寫(xiě)腳本和快速開(kāi)發(fā)應(yīng)用的編程語(yǔ)言，隨著版本的不斷更新和語(yǔ)言新功能的添加，逐漸被用于獨(dú)立的、大型項(xiàng)目的開(kāi)發(fā)。"

python三種注釋方法

python三種注釋方法：

方式1：

單行注釋?zhuān)簊hift + #（在代碼的最前面輸入，非選中代碼進(jìn)行注釋?zhuān)?/p>

多行注釋?zhuān)和瑔涡幸粯釉诿恳恍械那懊孑斎雜hift + #。

相關(guān)推薦：《Python視頻教程》。

方式2：

單行和多行一樣的方式：Ctr+ /（前提是選中需要注釋的代碼）。

方式3：

輸入＇＇' '''或者＂＂" """，將要注釋的代碼插在中間。

Python注釋好處：

增強(qiáng)代碼的可讀性。由于個(gè)人編碼的習(xí)慣不同，可能我們自己寫(xiě)的代碼不是所有人都能讀懂。但是這在團(tuán)隊(duì)合作的項(xiàng)目里又是必須互相都需要看懂的，所以這個(gè)時(shí)候注釋就更利于團(tuán)隊(duì)之間的交流合作和代碼的拼接。

注釋代碼可以方便找出代碼的bug。很多時(shí)候我們的代碼無(wú)法運(yùn)行，這個(gè)時(shí)候我們就可以通過(guò)注釋的方法來(lái)看哪一行代碼出了問(wèn)題，這樣更利于檢查代碼的bug。

名稱(chēng)欄目：python函數(shù)注解,PYTHON注釋
鏈接地址：http://chinadenli.net/article6/dsgigog.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供定制網(wǎng)站、關(guān)鍵詞優(yōu)化、企業(yè)網(wǎng)站制作、Google、網(wǎng)站改版、軟件開(kāi)發(fā)

廣告

聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶(hù)投稿、用戶(hù)轉(zhuǎn)載內(nèi)容為主，如果涉及侵權(quán)請(qǐng)盡快告知，我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng)，如需處理請(qǐng)聯(lián)系客服。電話(huà)：028-86922220；郵箱：631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時(shí)需注明來(lái)源： 創(chuàng)新互聯(lián)