『無為則無心』Python基礎 — 6、Python的注釋
- 2021 年 6 月 24 日
- 筆記
- 測試基礎必會技能 - Python基礎
提示：完成了前面的準備工作，之後的文章開始介紹Python的基本語法了。
Python程式碼的基本規範如下：
- 1、Python 文件將以 .py 為擴展名。
- 2、在Python中嚴格區分大小寫（大小寫敏感），如果寫錯了大小寫，程式會報錯。
- 3、Python中的每一行就是一條語句，每條語句以換行結束，不用
;分號結束。 - 4、Python是縮進嚴格的語言，所以在Python中不要隨便寫縮進。
- 縮進的好處是強迫你寫出縮進較少的程式碼，你會傾向於把一段很長的程式碼拆分成若干函數，從而得到縮進較少的程式碼。
- 縮進的壞處就是
複製－粘貼功能失效了，當你重構程式碼時，粘貼過去的程式碼必須重新檢查縮進是否正確。
- 5、一條語句可以分多行編寫，多行編寫時語句後邊以
\結尾 。 - 6、Python中每一行語句不要過長（規範中建議每行不要超過80個字元）。
擴展：
- Python中文文檔地址：//docs.python.org/zh-cn/3/index.html。
- 關於程式碼規範：
Python 官方提供有一系列 PEP（Python Enhancement Proposals） 文檔，其中第 8 篇文檔專門針對 Python 的程式碼格式 給出了建議，也就是俗稱的 PEP 8。
文檔地址：//www.python.org/dev/peps/pep-0008/。
1、注釋的作用
通過使用自己熟悉的語言，在程式中提示或解釋某些關鍵程式碼的思路、作用和功能等，能夠大大增強程式的可讀性。（程式碼的可讀性是非常重要的）
程式碼注釋效果如下圖：
- 沒有添加註釋的程式碼。
- 添加註釋的程式碼。
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 + /。
