註釋

註釋

目標

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

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/

任何語言的程序員，編寫出符合規範的代碼，是開始程序生涯的第一步