1. 程式人生 > >Pyhton 單行、多行註釋符號使用方法及規範

Pyhton 單行、多行註釋符號使用方法及規範

Python 中的註釋有多種,有單行註釋,多行註釋,批量註釋,中文註釋也是常用的。python註釋也有自己的規範,在文章中會介紹到。註釋可以起到一個備註的作用,團隊合作的時候,個人編寫的程式碼經常會被多人呼叫,為了讓別人能更容易理解程式碼的通途,使用註釋是非常有效的。

一、python單行註釋符號(#)

井號(#)常被用作單行註釋符號,在程式碼中使用#時,它右邊的任何資料都會被忽略,當做是註釋。
print 1 #輸出1
#號右邊的內容在執行的時候是不會被輸出的。

二、批量、多行註釋符號

在python中也會有註釋有很多行的時候,這種情況下就需要批量多行註釋符了。多行註釋是用三引號'''   '''包含的,例如:
python 多行註釋符


可能有的人會說這不是和多行字串混淆了嗎,但是我看到的許多程式設計師也是這麼用的,使用時候注意區分下就好。

三、python中文註釋方法

在python編寫程式碼的時候,避免不了會出現或是用到中文,這時候你需要在檔案開頭加上中文註釋。如果開頭不宣告儲存編碼的格式是什麼,那麼它會預設使用ASKII碼儲存檔案,這時如果你的程式碼中有中文就會出錯了,即使你的中文是包含在註釋裡面的。所以加上中文註釋很重要。
#coding=utf-8
或者:
#coding=gbk
提示:以上兩種都可以代表中文註釋,我看過的更多人使用urf-8這種的比較多。

一個好的程式設計師,為程式碼加註釋是必須要作的。但要確保註釋要說的都是重要的事情,像看一眼就知道是幹什麼的,無用的程式碼是不需要加註釋的。