python中的注釋功能和使用詳解

2021-10-24 08:03:50 字數 1980 閱讀 9638

注釋的目的:對**進行說明,增強程式的可讀性。

python中的注釋常用的有兩種:

單行注釋

在每一行前加#號,直到這行結束為止的所有內容都是注釋

說明多行**的功能時一般將注釋放在**的上一行

說明單行**的功能時一般將注釋放在**的右側

樣例1

>>> #我的第乙個python程式

>>> print("hello world!")

hello world!

注釋應該簡短、貼切、切中要害。

**行中的注釋最多為72個字元。如果您的注釋接近或超過了該長度,

則需要將其轉變為多行注釋。

樣例2

>>> #第一行說明

>>> #第二行說明

>>> #第三行說明

多行注釋這樣太累,換成檔案式直接選中想要注釋的多行內容再**ctrl+/**搞定。

如果想取消,選中再重複按鍵即可。

(記事本無此功能,像sublime text等ide都可實現)

多行注釋

在要注釋的內容前後行加三個單引號或雙引號

(建議用三個雙引號,三個單引號容易引起衝突)

從技術上講,這並不是乙個注釋。它僅僅是乙個沒有分配給任何變數的字串,

所以程式不會呼叫或引用它。

由於它在執行時會被忽略並且不會出現在位元組碼中,所以它可以有效地充當注釋。

樣例3「」"

第一行說明

第二行說明

第三行說明

「」"多行注釋通常用來為 python 檔案、模組、類或者函式等新增版權或者功能描述資訊。

注意事項:

多行注釋不支援巢狀;

當注釋符成為字串的一部分出現時,就不能再將它們視為注釋標記。

樣例4

>>>print('''hello world''')

hello world

>>>print("""i am chinese!""")

i am chinese!

注釋的其他功能

1,匯入編碼格式

python2.x程式預設是ascii編碼,如果有中文輸入需要編碼注釋,必須要新增一行宣告檔案

宣告必須放在**的第一行或第二行。

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

(python3的預設編碼是utf-8,可以不用)

2,在除錯程式的過程中使用注釋可以縮小錯誤所在的範圍,提高除錯程式的效率。

注釋應避免的狀況:

1,w.e.t.注釋

這類問題可簡寫為

w.e.t. 「wrote everything twice」 or 「wasted everyone』s time」

d.r.y. 「don』t repeat yours」

樣例6return a #returns a

2,利用注釋來彌補**

注釋有時會反映出您的**可能存在深層次的問題,注釋是試圖隱藏**自身問題的一種方法,

但注釋應該支援您的**,而不是試圖彌補它。如果您的**編寫得很糟糕,那麼任何注釋都不會修復它。

樣例7

#輸入姓名和年齡並列印

a = input("請輸入你的姓名:") #輸入你的姓名

b = input("請輸入你的年齡:") #輸入你的年齡

print("你的姓名:{}你的年齡{}".format(a,b)) #列印你的姓名和年齡

通過為變數,函式和集合等指定合理的名稱,可使**變得簡單

樣例8

your_name = input("請輸入你的姓名:")

your_age = input("請輸入你的年齡:")

print("你的姓名:{}你的年齡{}".format(a,b))

3,避免**以外的詞句

注釋裡不要出現一些含有政治,人身攻擊,粗魯,負能量的詞句。

只寫與**相關的內容。

Python中的注釋

object object object object object object 單行注釋以開頭,例如 object object object object object object print 6 輸出6 object object object object object object p...

Python中的注釋

object object object object object object 單行注釋以開頭,例如 object object object object object object print 6 輸出6 object object object object object object p...

perl中單行注釋和多行注釋使用介紹

perl中的程式注釋 單行注釋和多行注釋 一 單行注釋 以 開頭的行都被perl認為是注釋。但是有乙個例外,perl程式的第一行是 開頭的,他指定了perl程式的直譯器。例如 print 1 這種方法有個缺點,就是每次 只能夠注釋一行,如果要注釋的 很長,那就是一件很麻煩的事情。二 多行注釋 最常用...