# 這是單行註解
print("Hello") # 行尾註解
Python 無原生多行註解語法,社群慣例使用多行字串字面值 (未指派給變數),直譯器會忽略:
"""
這是多行註解區塊
第 2 行說明
第 3 行說明
"""
print("執行中...")
模組、類別、函數首行的字串字面值會成為 __doc__ 屬性,支援 help()、pydoc、Sphinx 等工具提取:
def calculate_area(radius):
"""計算圓面積。
Args:
radius (float): 半徑
Returns:
float: 面積
"""
return 3.14159 * radius ** 2
print(calculate_area.__doc__)
#,簡短說明「做什麼」或「為什麼」。"""...""",暫時停用代碼或區塊說明。typing 模組,減少註解說明型別需求。flake8 + pydocstyle 檢查文件字串規範。Sphinx 產生專案文件網站。