python添加注釋的方法

這篇文章主要介紹了python添加注釋的方法，具有一定借鑒價值，需要的朋友可以參考下。希望大家閱讀完這篇文章后大有收獲。下面讓小編帶著大家一起了解一下。

通常而言，合理的代碼注釋應該占源代碼的 1/3 左右。Python 語言允許在任何地方插入空字符或注釋，但不能插入到標識符和字符串中間。

在 Python 中，通常包括 3 種類型的注釋，分別是單行注釋、多行注釋和中文編碼聲明注釋。

Python單行注釋

Python 中使用井號（‘#’）作為單行注釋的符號，語法格式為：

# 注釋內(nèi)容

也就是說，從符號‘#’處開始，直到換行處結(jié)束，此部分內(nèi)容都作為注釋的內(nèi)容，當程序執(zhí)行時，這部分內(nèi)容會被忽略。

單行注釋放置的位置，既可以是要注釋代碼的前一行，例如：

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

也可以是注釋代碼的右側(cè)，例如：

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

基于注釋在程序中所起到的作用，以上兩種方式雖然放置位置不同，但程序的執(zhí)行結(jié)果是相同的，都是輸出“Hello World!”。

Python多行注釋

多行注釋指的是可以一次性注釋程序中多行的內(nèi)容（包含一行）。多行注釋的語法有 2 種，分別是：

'''
使用 3 個單引號分別作為注釋的開頭和結(jié)尾
可以一次性注釋多行內(nèi)容
這里面的內(nèi)容全部是注釋內(nèi)容
'''

或者

"""
使用 3 個雙引號分別作為注釋的開頭和結(jié)尾
可以一次性注釋多行內(nèi)容
這里面的內(nèi)容全部是注釋內(nèi)容
"""

多行注釋通常用來為 Python 文件、模塊、類或者函數(shù)等添加版權(quán)、功能描述等信息。需要注意的是，在 Python 中，如果多行注釋標記（三單引號或三雙引號）作為語句的一部分出現(xiàn)，就不能再將它們視為多行注釋的標記，而應看做是字符串的標志（同雙引號的作用相同），例如：

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

該語句的執(zhí)行結(jié)果為：Hello，World!。由此可見，Python 解釋器沒有將這里的三個單引號看做是注釋，而是將它們看作是字符串的標志。

感謝你能夠認真閱讀完這篇文章，希望小編分享python添加注釋的方法內(nèi)容對大家有幫助，同時也希望大家多多支持億速云，關(guān)注億速云行業(yè)資訊頻道，遇到問題就找億速云，詳細的解決方法等著你來學習!