Python中注釋(多行注釋和單行注釋)的用法例項

2022-10-04 16:21:16 字數 2052 閱讀 1178

前言

學會向程式中新增必要的注釋,也是很重要的。注釋不僅可以用來解釋程式某些部分的作用和功能(用自然語言描述**的功能),在必要時,還可以將**臨時移除,是除錯程式的好幫手。

當然,新增注釋的最大作用還是提高程式的可讀性!很多時候,筆者寧願自己寫乙個應用,也不願意去改進別人的**,沒有合理的注釋是乙個重要原因。雖然良好的**可自成文擋,但我們永遠也不清楚今後讀這段**的人是誰,他是否和你有相同的思路。或者一段時間以後,你自己也不清楚當時寫這段**的目的了。

總的來說,一旦程式中注釋掉某部分內容,則該內容將會被 python 直譯器忽略,換句話說,此部分內容將不會被執行。

通常而言,合理的**注釋應該佔源**的 1/3 左右。python 語言允許在任何地方插入空字元或注釋,但不能插入到識別符號和字串中間。

在 python 中,通常包括 3 種型別的注釋,分別是單行注釋、多行注釋和中文編碼宣告程式設計客棧注釋。

python單行注釋

python 中使用井號(『#')作為單行注釋的符號,語法格式為:

# 注釋內容

也就是說,從符號『#'處開始,直到換行處結束,此ayhgjr部分內容都作為注釋的內容,當程式執行時,這部分內容會被忽略。

單行注釋放置的位置,既可以是要注釋**的前一行,例如:

#這是一行簡單的注釋

print ("hello world!")

也可以是注釋**的右側,例如:

print ("hello world!") #這是一行簡單的注釋

基於注釋在程式中所起到的作用,以上兩種方式雖然放置位置不同www.cppcns.com,但程式的執行結果是相同的,都是輸出「hello world!」。

python多行注釋

多行注釋指的是可以一次性注釋程式中多行的內容(包含一行)。多行注釋的語法有 2 種,分別是:

'''使用 3 個單引號分別作為注釋的開頭和結尾

可以一次性注釋多行內容

這裡面的內容全部是注釋內容

'''或者"""

使用 3 個雙引號分別作為注釋的開頭和結尾

可以一次性注釋多行內容

這裡面的內容全部是注釋內容

"""多行注釋通常用來為 python 檔案、模組、類或者函式等新增版權、功能描述等資訊。需要注意的是,在 python 中,如果多行注釋標記(三單引號或三雙引號)作為語句的一部分出現,就不能再將它們視為多行注釋的標記,而應看做是字串的標誌(同雙引號的作用相同),例如:

print('''hello,world!''')

該語句的執行結果為:hello,world!。由此可見,python 直譯器沒有將這裡的三個單引號看做是注釋,而是將它們看作是字串的標誌。

python中文編碼宣告注釋

python 還提供了一種特殊的中文編碼宣告注釋,其主要用來解決 python 2.x 中不支援直接寫中文的問題。雖然此問題在 python 3.x 中已經不存在啦,但為了規範編碼,增強**的可執行性,方便其他程式設計師及時了解程式所用的編碼,建議初學者在程式開頭處加上中文編碼宣告注釋。

中文編碼宣告注釋的語法有如下 2 種:

# -*- codin編碼 -*-

或者# coding=編碼

語法中的編碼,指的是編寫程式所用的字元編碼型別,比如 utf-8、gbk 編碼等。另外,在第一種語法中,『-*-'並沒有實際意義,只是為了美觀才加上去了,因此,第一種語法格式中可以直接將前後的『-*-'去掉。

舉個例子,如果指定編碼為 utf-8,則可以使用下面的中文編碼宣告注釋:

# coding:utf-8

或者# coding=utf-8

注意,給**新增注釋是是注釋的基本用法,它還有乙個更實用的功能,即用來除錯程式。舉個例子,如果你覺得某段**可能有問題,可以先把這段**注釋起來,讓 python 直譯器忽略這段**,然後執行。如果程式可以正常執行,則可以說明錯誤就是由這段**引起的;反之,如果依然出現相同的錯誤,則可以說明錯誤不是由這段**引起的。

由此可見,在除錯程式時,學會注釋**,可以縮小錯誤所在的範圍,提高除錯程式的效率。

總結本文標題: python中注釋(多行注釋和單行注釋)的用法例項

本文位址: /jiaoben/python/270570.html

Python注釋符號(多行注釋和單行注釋)用法詳解

為程式新增注釋可以用來解釋程式某些部分的作用和功能,提高程式的可讀性。除此之外,注釋也是除錯程式的重要方式。在某些時候,我們不希望編譯 執行程式中的某些 這時就可以將這些 注釋掉。當然,新增注釋的最大作用還是提高程式的可讀性!很多時候,筆者寧願自己寫乙個應用,也不願意去改進別人的應用,沒有合理的注釋...

python 多行注釋

最近看了點python資料,挺有意思的,寫 的時候突然發現python的注釋只有針對於單行的注釋 用 上網找了一下相關資料,發現好多人也都在討論python多行注釋的問題,裡面介紹的也都是關於單行的注釋,要想多行注釋只能每行 前面都加上 我靠!這可挺鬱悶的,儘管使用eclipse快捷鍵可以進行批量注...

C 中 注釋和 注釋的區別

會被編譯,不會 所以使用 會減慢編譯的速度 但不會影響執行速度 會在其它的人呼叫你的 時提供智慧型感知 也是一種注釋,但是這種注釋主要有兩種作用 1.這些注釋能夠生成乙個xml檔案。這樣呢,看起來會對程式的內容一目了然。2.以這種方式對你的類,屬性,方法等等加上注釋之後,當你在其他地方使用以這種方式...