『無為則無心』Python基礎 — 6、Python的註釋

繁華似錦Fighting發表於2021-06-24
Python

目錄

提示：完成了前面的準備工作，之後的文章開始介紹Python的基本語法了。

Python程式碼的基本規範如下：

  • 1、Python 檔案將以 .py 為副檔名。
  • 2、在Python中嚴格區分大小寫（大小寫敏感），如果寫錯了大小寫，程式會報錯。
  • 3、Python中的每一行就是一條語句，每條語句以換行結束，不用;分號結束。
  • 4、Python是縮排嚴格的語言，所以在Python中不要隨便寫縮排。
    • 縮排的好處是強迫你寫出縮排較少的程式碼，你會傾向於把一段很長的程式碼拆分成若干函式，從而得到縮排較少的程式碼。
    • 縮排的壞處就是複製－貼上功能失效了，當你重構程式碼時，貼上過去的程式碼必須重新檢查縮排是否正確。
  • 5、一條語句可以分多行編寫，多行編寫時語句後邊以\結尾 。
  • 6、Python中每一行語句不要過長（規範中建議每行不要超過80個字元）。

擴充套件：

1、註釋的作用

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

程式碼註釋效果如下圖：

  • 沒有新增註釋的程式碼。
    image
  • 新增註釋的程式碼。
    image

2、註釋的分類

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

單行註釋

#作為單行註釋的符號。只註釋一行內容，語法如下：

# 註釋內容

多行註釋

可以註釋多行內容，常用來為 Python 函式、類、模組等等新增功能、版本和作者等描述資訊， 語法如下：

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

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

3、註釋的注意事項

  • Python 直譯器（Python Interpreter）在執行程式（程式碼）時會忽略註釋部分，不做任何處理。
    當Python直譯器解析Python檔案的時候，一旦發現出現了#，就會認為#右邊的文字全部都是說明性的文字，Python的直譯器會直接跳過這一行，解釋下一行程式碼。
  • 極簡單的註釋可以放到一行程式碼的後面，一般習慣程式碼後面新增兩個空格，再書寫註釋文字。
    print('hello Python')  # 輸出
  • #號和註釋之間需要加上一個空格，不是強制，是規範。
  • Python 多行註釋不支援巢狀，如下所示為錯誤寫法：
    '''
外層註釋
    '''
    內層註釋
    '''
'''
  • 多行註釋符號'''或"""也可以作為字串的開始和結束標記。
    Python 中當多行註釋符號作為字串的一部分出現時，就不能再將它們當做多行註釋標記，而應該看做是字串的一部分，如下所示：
    #方式一
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)

"""
#執行結果都是
hello world ! hello python !
hello world ! 
真香
是真的
"""

4、什麼時候需要使用註釋

  • 註釋不是越多越好，對於一目瞭然的程式碼，不需要新增註釋。
  • 對於 複雜的操作，應該在操作開始前寫上若干行註釋。
  • 絕不要描述程式碼，假設閱讀程式碼的人比你更懂 Python，他只是不知道你的程式碼要做什麼，程式碼註釋要做功能性描述。

在一些正規的開發團隊，通常會有 程式碼稽核 的慣例，就是一個團隊中彼此閱讀對方的程式碼。

5、總結

  • 註釋是一個程式設計師必須要具有的良好程式設計習慣。
  • 註釋的作用有兩個：
    • 說明程式碼。
    • 除錯程式。
  • 註釋快捷鍵
    • 單行註釋：ctrl + /。
    • 多行註釋：沒有，只能選中多行，在ctrl + /。

相關文章