Python中的注釋是什么以及如何使用它們？

您是否曾經(jīng)要求任何程序員解釋他一年前編寫的代碼？還是您曾經(jīng)嘗試閱讀自己以前編寫的代碼？如果您必須從頭開始重新分析每個(gè)代碼塊，這將變得非常耗時(shí)且累人！最好的辦法是添加評(píng)論。注釋不僅僅是增加代碼行數(shù)，而且是使代碼有意義的最佳方法。這是一個(gè)完整的指南，可以幫助您了解有關(guān)Python中注釋的所有信息。

在繼續(xù)之前，讓我們只是有一個(gè)快速通過所有具有主題步行過海灣紅這篇文章中-

What are Comments?

How to make use of Comments?

How does Python interpret Comments?

Types of comments:

Single-line

Multi-line

Docstrings Comments

什么是注釋？

一般來說，評(píng)論是一個(gè)人思想的表達(dá)。在編程中，注釋是程序員一致的語句，它們描述代碼塊的含義。當(dāng)您編寫大型代碼時(shí)，它們將非常有用。當(dāng)擁有一個(gè)一百頁左右的程序時(shí)，記住每個(gè)變量的名稱實(shí)際上是不人道的。因此，使用注釋將使您或其他人很容易閱讀和修改代碼。

注釋非常重要，但是您將需要知道如何使用它們，這正是以下主題中討論的內(nèi)容。

如何使用注釋？

注釋可以包含在任何位置，這也意味著內(nèi)聯(lián)。最佳實(shí)踐是在編寫代碼以及編寫代碼的方式中編寫相關(guān)注釋。

以下是一些在注釋代碼時(shí)將為您提供幫助的關(guān)鍵點(diǎn)：

評(píng)論必須簡短且相關(guān)

它們是特定于所包含的代碼塊的

確保使用體面的語言，因?yàn)槭褂么盅苑x語是不道德的

不要評(píng)論不言自明的臺(tái)詞

現(xiàn)在您已經(jīng)知道注釋的重要性，讓我們繼續(xù)前進(jìn)，看看如何用Python編寫注釋。

如何用Python編寫注釋？

Python中的注釋以＃字符開頭。但是，有時(shí)也可以使用docstrings（用三引號(hào)引起來的字符串）進(jìn)行注釋，本文將對此進(jìn)行進(jìn)一步描述。

例：

#Comments in Python start like this print("Comments in Python start with a #")

輸出：?Python中的注釋以＃開頭

如您在上面的輸出中看到的，執(zhí)行了print語句，而在輸出中不存在comment語句。

如果您有多個(gè)注釋行，則所有注釋行都必須以＃開頭。

例：

#Comments in Python #start with this character print("Comments in Python")

輸出：?Python注釋

上面的輸出顯示在輸出中未返回所有以＃字符為前綴的行。

繼續(xù)前進(jìn)，讓我們看一下注釋的解釋方式以及為什么它們永遠(yuǎn)不會(huì)出現(xiàn)在輸出中。

Python如何解釋注釋？

當(dāng)解釋器在任何地方遇到＃符號(hào)時(shí)（字符串內(nèi)部除外，因?yàn)樽址械模Ｖ皇潜硎荆＃?，它?huì)忽略出現(xiàn)在該行末尾的所有內(nèi)容。＃標(biāo)記實(shí)際上告訴解釋器停止讀取之后的所有內(nèi)容。

評(píng)論類型

注釋可以是

單行或

多行

單行注釋：

它們可以顯示在單獨(dú)的行中，也可以與其他一些代碼內(nèi)聯(lián)。

例：

#multiplying two variables (this line starts with a #, hence will be ignored till line ends) a=1 b=2 c=a*b print(c) # printing result (inline comment, whatever is present after # will be ignored)

輸出：2

多行注釋：

多行注釋出現(xiàn)在多行中。所有要注釋的行都以＃開頭。如果不這樣做，將會(huì)遇到錯(cuò)誤。

例：

#adding 2 variables #pinting the result in a new variable a=2 b=3 c=a+b print(c)

輸出：5

上面的輸出表明，省略了以＃字符為前綴的前兩個(gè)程序行，并執(zhí)行了程序的其余部分，并返回了它們各自的輸出。

您也可以使用非常好的快捷方式注釋多行。您需要做的就是按住ctrl鍵，并在要包含＃個(gè)字符的任何地方單擊鼠標(biāo)左鍵，然后只鍵入一次＃。這將注釋您引入光標(biāo)的所有行。

如果要從多行中刪除＃，則可以執(zhí)行相同的操作，并僅使用一次Backspace鍵，所有選擇的＃個(gè)字符都將被刪除。

但是，在注釋文檔時(shí)，這些多行注釋看起來非常不愉快。以下主題將向您介紹此問題的解決方案。

Docstring注釋：

Docstrings實(shí)際上不是注釋，而是文檔字符串。這些文檔字符串用三引號(hào)引起來。它們沒有分配任何變量，因此有時(shí)也可以用作注釋的目的。

當(dāng)您需要關(guān)聯(lián)與類或函數(shù)等有關(guān)的一些文檔時(shí)，尤其可以使用它們。

例：

""" Using docstring as a comment. This code divides 2 numbers """ x=8 y=4 z=x/y print(z)

輸出：2.0

如您所見，輸出不包含docstring，因此，它已被省略，因?yàn)樗诖a啟動(dòng)之前就已出現(xiàn)。

但是，如果僅執(zhí)行一個(gè)不帶以下代碼的文檔字符串，如上所示，則輸出將是字符串本身。

例：

""" Using docstring as a comment. This code divides 2 numbers """

輸出："

使用文檔字符串作為注釋。

該代碼將2個(gè)數(shù)字相除

"

在上面的輸出中，該文檔字符串已經(jīng)打印，因?yàn)樗竺鏇]有任何代碼。

現(xiàn)在，如果在編寫代碼后它仍然存在，則在結(jié)果之后仍將打印文檔字符串。

例：

x=8 y=4 z=x/y print(z) """ Using docstring as a comment. This code divides 2 numbers """

輸出：

2.0

“

使用文檔字符串作為注釋。

該代碼將2個(gè)數(shù)字相除

”

如您所見，文檔字符串已在輸出之后打印出來。因此，因此，如上所述，docstring在不同位置的行為取決于在代碼中出現(xiàn)的位置。這使我們到了本文的結(jié)尾。希望您喜歡在Python中學(xué)習(xí)注釋。確保盡可能多地練習(xí)并恢復(fù)經(jīng)驗(yàn)。

IoT Linux Python 云計(jì)算 機(jī)器學(xué)習(xí)

版權(quán)聲明：本文內(nèi)容由網(wǎng)絡(luò)用戶投稿，版權(quán)歸原作者所有，本站不擁有其著作權(quán)，亦不承擔(dān)相應(yīng)法律責(zé)任。如果您發(fā)現(xiàn)本站中有涉嫌抄襲或描述失實(shí)的內(nèi)容，請聯(lián)系我們jiasou666@gmail.com 處理，核實(shí)后本網(wǎng)站將在24小時(shí)內(nèi)刪除侵權(quán)內(nèi)容。

版權(quán)聲明：本文內(nèi)容由網(wǎng)絡(luò)用戶投稿，版權(quán)歸原作者所有，本站不擁有其著作權(quán)，亦不承擔(dān)相應(yīng)法律責(zé)任。如果您發(fā)現(xiàn)本站中有涉嫌抄襲或描述失實(shí)的內(nèi)容，請聯(lián)系我們jiasou666@gmail.com 處理，核實(shí)后本網(wǎng)站將在24小時(shí)內(nèi)刪除侵權(quán)內(nèi)容。