註釋

目標

• 註釋的作用
• 單行註釋（行註釋）
• 多行註釋（塊註釋）

01. 註釋的作用

使用用自己熟悉的語言，在程式中對某些程式碼進行標註說明，增強程式的可讀性

02. 單行註釋(行註釋)

• 以 # 開頭，# 右邊的所有東西都被當做說明文字，而不是真正要執行的程式，只起到輔助說明作用

• 示例程式碼如下：

# 這是第一個單行註釋
print("hello python")

為了保證程式碼的可讀性，# 後面建議先新增一個空格，然後再編寫相應的說明文字

在程式碼後面增加的單行註釋

• 在程式開發時，同樣可以使用 # 在程式碼的後面（旁邊）增加說明性的文字

• 但是，需要注意的是，為了保證程式碼的可讀性，註釋和程式碼之間 至少要有 兩個空格

• 示例程式碼如下：

print("hello python")  # 輸出 `hello python`

03. 多行註釋（塊註釋）

• 如果希望編寫的 註釋資訊很多，一行無法顯示，就可以使用多行註釋

• 要在 Python 程式中使用多行註釋，可以用 一對 連續的 三個 引號(單引號和雙引號都可以)

• 示例程式碼如下：

"""
這是一個多行註釋

在多行註釋之間，可以寫很多很多的內容……
"""
 
 
print("hello python")

什麼時候需要使用註釋？

1. 註釋不是越多越好，對於一目瞭然的程式碼，不需要添加註釋
2. 對於 複雜的操作，應該在操作開始前寫上若干行註釋
3. 對於 不是一目瞭然的程式碼，應在其行尾添加註釋（為了提高可讀性，註釋應該至少離開程式碼 2 個空格）
4. 絕不要描述程式碼，假設閱讀程式碼的人比你更懂 Python，他只是不知道你的程式碼要做什麼

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

關於程式碼規範

• Python 官方提供有一系列 PEP（Python Enhancement Proposals） 文件
• 其中第 8 篇文件專門針對 Python 的程式碼格式 給出了建議，也就是俗稱的 PEP 8
• 文件地址：https://www.python.org/dev/peps/pep-0008/
• 谷歌有對應的中文文件：http://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/python_style_rules/

任何語言的程式設計師，編寫出符合規範的程式碼，是開始程式生涯的第一步