# 注釋 ## 目標 * 注釋的作用 * 單行注釋（行注釋） * 多行注釋（塊注釋） ## 01. 注釋的作用 > 使用用自己熟悉的語言，在程序中對某些代碼進行標注說明，增強程序的可讀性  ## 02. 單行注釋(行注釋) * 以 `#` 開頭，`#` 右邊的所有東西都被當做說明文字，而不是真正要執行的程序，只起到輔助說明作用 * 示例代碼如下： ```python # 這是第一個單行注釋 print("hello python") ``` > 為了保證代碼的可讀性，`#` 后面建議先添加一個空格，然后再編寫相應的說明文字 ### 在代碼后面增加的單行注釋 * 在程序開發時，同樣可以使用 `#` 在代碼的后面（旁邊）增加說明性的文字 * 但是，需要注意的是，**為了保證代碼的可讀性**，**注釋和代碼之間** 至少要有 **兩個空格** * 示例代碼如下： ```python print("hello python") # 輸出 `hello python` ``` ## 03. 多行注釋（塊注釋） * 如果希望編寫的 **注釋信息很多，一行無法顯示**，就可以使用多行注釋 * 要在 Python 程序中使用多行注釋，可以用 **一對 連續的 三個 引號**(單引號和雙引號都可以) * 示例代碼如下： ```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/ > 任何語言的程序員，編寫出符合規范的代碼，是開始程序生涯的第一步