文章目錄
- 單行注釋
- 多行注釋
- 使用多個 # 符號
- 使用三引號(''' 或 """)
- 特殊注釋
- Shebang(Unix/Linux 腳本聲明)
- 編碼聲明(Python 2 需要)
- 文檔字符串(Docstring)
在 Python 中,注釋(Comments) 用于解釋代碼,提高可讀性,且不會被 Python 解釋器執行。Python 支持 單行注釋 和 多行注釋。
單行注釋
使用 # 符號,從 # 開始到行尾的內容都會被忽略。
# 這是一個單行注釋
print("Hello, World!") # 這也是注釋(行尾注釋)
適用場景:
1、簡短說明代碼功能。
2、臨時禁用某行代碼(調試時常用):
# print("這行代碼不會執行")
多行注釋
Python 沒有專門的多行注釋語法,但可以通過以下兩種方式實現:
使用多個 # 符號
# 這是多行注釋的第一行
# 這是第二行
# 這是第三行
print("多行注釋示例")
使用三引號(‘’’ 或 “”")
雖然三引號是多行字符串的語法,但如果字符串未被賦值給變量,Python 會忽略它,因此可作為注釋使用:
'''
這是多行注釋(實際上是字符串)
可以寫多行內容
Python 會忽略未賦值的三引號字符串
'''
print("三引號作為注釋")
如果三引號字符串被賦值給變量,它就是字符串而非注釋:
docstring = """這是字符串,不是注釋"""
特殊注釋
Shebang(Unix/Linux 腳本聲明)
在文件首行指定 Python 解釋器路徑(僅限 Unix/Linux 系統):
#!/usr/bin/env python3
print("Shebang 注釋")
編碼聲明(Python 2 需要)
指定文件編碼(Python 3 默認 UTF-8,可省略):
# -*- coding: utf-8 -*-
文檔字符串(Docstring)
用于函數、類或模塊的說明,用三引號包裹,可通過 doc 屬性訪問:
def add(a, b):"""計算兩個數的和參數: a (int), b (int)返回: int"""return a + bprint(add.__doc__) # 輸出文檔字符串