Python基礎(chǔ)之注釋的用法

前言

Python代碼的基本規(guī)范如下：

1、Python 文件將以 .py 為擴展名。

2、在Python中嚴(yán)格區(qū)分大小寫（大小寫敏感），如果寫錯了大小寫，程序會報錯。

3、Python中的每一行就是一條語句，每條語句以換行結(jié)束，不用;分號結(jié)束。

4、Python是縮進嚴(yán)格的語言，所以在Python中不要隨便寫縮進。

• 縮進的好處是強迫你寫出縮進較少的代碼，你會傾向于把一段很長的代碼拆分成若干函數(shù)，從而得到縮進較少的代碼。
• 縮進的壞處就是復(fù)制－粘貼功能失效了，當(dāng)你重構(gòu)代碼時，粘貼過去的代碼必須重新檢查縮進是否正確。

5、一條語句可以分多行編寫，多行編寫時語句后邊以\結(jié)尾 。

6、Python中每一行語句不要過長（規(guī)范中建議每行不要超過80個字符）。

擴展：

Python中文文檔地址：https://docs.python.org/zh-cn/3/index.html。關(guān)于代碼規(guī)范：
Python 官方提供有一系列 PEP（Python Enhancement Proposals） 文檔，其中第 8 篇文檔專門針對 Python 的代碼格式 給出了建議，也就是俗稱的 PEP 8。
文檔地址：https://www.python.org/dev/peps/pep-0008/。

一、注釋的作用

通過使用自己熟悉的語言，在程序中提示或解釋某些關(guān)鍵代碼的思路、作用和功能等，能夠大大增強程序的可讀性。（代碼的可讀性是非常重要的）

代碼注釋效果如下圖：

沒有添加注釋的代碼。

添加注釋的代碼。

二、注釋的分類

注釋分為兩類：單行注釋 和 多行注釋。

單行注釋

#作為單行注釋的符號。只注釋一行內(nèi)容，語法如下：

# 注釋內(nèi)容

多行注釋

可以注釋多行內(nèi)容，常用來為 Python 函數(shù)、類、模塊等等添加功能、版本和作者等描述信息， 語法如下：

#寫法一：一對三雙引號
"""
  第一行注釋
  第二行注釋
  第三行注釋
"""

#寫法二：一對三單引號
'''
  注釋1
  注釋2
  注釋3
'''

三、注釋的注意事項

Python 解釋器（Python Interpreter）在執(zhí)行程序（代碼）時會忽略注釋部分，不做任何處理。
當(dāng)Python解釋器解析Python文件的時候，一旦發(fā)現(xiàn)出現(xiàn)了#，就會認(rèn)為#右邊的文字全部都是說明性的文字，Python的解釋器會直接跳過這一行，解釋下一行代碼。

極簡單的注釋可以放到一行代碼的后面，一般習(xí)慣代碼后面添加兩個空格，再書寫注釋文字。

print('hello Python')  # 輸出

#號和注釋之間需要加上一個空格，不是強制，是規(guī)范。

Python 多行注釋不支持嵌套，如下所示為錯誤寫法：

'''
外層注釋
    '''
    內(nèi)層注釋
    '''
'''

多行注釋符號'''或"""也可以作為字符串的開始和結(jié)束標(biāo)記。
Python 中當(dāng)多行注釋符號作為字符串的一部分出現(xiàn)時，就不能再將它們當(dāng)做多行注釋標(biāo)記，而應(yīng)該看做是字符串的一部分，如下所示：

#方式一
print("hello world ! hello python !")
print('hello world !')
print("""真香""")
print('''是真的''')

#方式二
str1 = "hello world ! hello python !"
str2 = 'hello world !'
str3 = """真香"""
str4 = '''是真的'''
print(str1)
print(str2)
print(str3)
print(str4)

"""
#執(zhí)行結(jié)果都是
hello world ! hello python !
hello world ! 
真香
是真的
"""

四、什么時候需要使用注釋

• 注釋不是越多越好，對于一目了然的代碼，不需要添加注釋。
• 對于 復(fù)雜的操作，應(yīng)該在操作開始前寫上若干行注釋。
• 絕不要描述代碼，假設(shè)閱讀代碼的人比你更懂 Python，他只是不知道你的代碼要做什么，代碼注釋要做功能性描述。

在一些正規(guī)的開發(fā)團隊，通常會有 代碼審核 的慣例，就是一個團隊中彼此閱讀對方的代碼。

五、總結(jié)

注釋是一個程序員必須要具有的良好編程習(xí)慣。

注釋的作用有兩個：

• 說明代碼。
• 調(diào)試程序。

注釋快捷鍵

• 單行注釋：ctrl + /。
• 多行注釋：沒有，只能選中多行，在ctrl + /。

到此這篇關(guān)于Python基礎(chǔ)之注釋的用法的文章就介紹到這了,更多相關(guān)Python注釋內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！