python如何新增註釋

船頭尺發表於2021-09-11

python如何新增註釋

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

在 Python 中,通常包括 3 種型別的註釋,分別是單行註釋、多行註釋和中文編碼宣告註釋。

Python單行註釋

Python 中使用井號(‘#’)作為單行註釋的符號,語法格式為:

# 註釋內容

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

單行註釋放置的位置,既可以是要註釋程式碼的前一行,例如:

#這是一行簡單的註釋
print ("Hello World!")

也可以是註釋程式碼的右側,例如:

print ("Hello World!") #這是一行簡單的註釋

基於註釋在程式中所起到的作用,以上兩種方式雖然放置位置不同,但程式的執行結果是相同的,都是輸出“Hello World!”。

Python多行註釋

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

'''
使用 3 個單引號分別作為註釋的開頭和結尾
可以一次性註釋多行內容
這裡面的內容全部是註釋內容
'''

或者

"""
使用 3 個雙引號分別作為註釋的開頭和結尾
可以一次性註釋多行內容
這裡面的內容全部是註釋內容
"""

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

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

該語句的執行結果為:Hello,World!。由此可見,Python 直譯器沒有將這裡的三個單引號看做是註釋,而是將它們看作是字串的標誌。更多學習內容,請點選

來自 “ ITPUB部落格 ” ,連結:http://blog.itpub.net/3016/viewspace-2835903/,如需轉載,請註明出處,否則將追究法律責任。

相關文章