Pyhton中單行與多行註解的使用方法及規範

前言

註解可以起到一個備註的作用，團隊合作的時候，個人編寫的程式碼經常會被多人調用，為了讓別人能更容易理解程式碼的通途，使用註解是非常有效的。

Python  註解符

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

井號(#)常被用作單行註解符號，在程式碼中使用#時，它右邊的任何資料都會被忽略，當做是註解。

print 1 #输出1

#號右邊的內容在執行的時候是不會被輸出的。

二、批次、多行註解符號

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

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

三、python中文註解方法

在python寫程式碼的時候，避免不了會出現或是用到中文，這時候你需要在檔案開頭加上中文註解。如果開頭不聲明保存編碼的格式是什麼，那麼它會預設使用ASKII碼保存文件，這時如果你的程式碼中有中文就會出錯了，即使你的中文是包含在註解裡面的。所以加上中文註解很重要。

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

提示：以上兩種都可以代表中文註釋，我看過的更多人使用urf-8這種的比較多。

總結

一個好的程式設計師，為程式碼加上註解是必須要作的。但要確保註解要說的都是重要的事情，像看一眼就知道是做什麼的，無用的程式碼是不需要加註解的。以上就是這篇文章的全部內容了，希望本文的內容對大家的學習或工作能帶來一定的幫助。