註解
目標
- 註解的作用
- 單行註解(行註解)
- 多行註解(塊註解)
039 程序的注释 01 注释的作用
當編寫的代碼閱讀起來永難度的時候,我們可以使用自己孰悉的語言對較難以閱讀的代碼進行標註,以方便下次閱讀時,能快速理解代碼所表達的含意。
040 程序的注視 02 单行注視
在開發 python 程序的時候,如果希望對程序中某些代碼加以說明,我們可以利用 # 在 # 的右邊輸入說明文字
示例代碼如下:
# 這是第一個單行註解
print("hello python")
為了保證代碼的可讀性, # 後面建議先添加一個空格,然後再編寫相應的說明文字
041 程序的注释 03 解释器不会解释#右侧的内容
以 # 開頭, # 右邊的所有東西都被當做說明文字,而不是真正要執行的程序,只起到輔助說明作用python ,解釋氣不會執行
042 程序的注释 04 在代码末尾增加单行注释
在程序開发時,同樣可以使用 # 在代碼的後面(旁邊)增加說明性的文字
但是,需要注意的是,為了保證代碼的可讀性,註解和代碼之間 至少要有 兩個空格
通常此種註解方式運用在代碼較短所要陳述的註解也較短的情形下
示例代碼如下:
print("hello python") # 輸出 `hello python`
043 程序的註解 05 多行註解
如果我們希望對編寫的代碼添加的描述信息非常非常的多,一行描述根本無法表達我們的心情,我們希望洋洋灑灑的抒發自己的文彩,這個時候就能使用多行註解
要在 Python 程序中使用多行註解,可以用 一對 連續的 三個 引號 (單引號和雙引號都可以)
示例代碼如下:
"""
#### 這是一個多行註解
...
...
在多行註解之間,可以寫很多很多的內容……
"""
print("hello python")
044 程序的注释 06 注释的使用以及代码规范文档
- 註解不是越多越好,對於一目了然的代碼,不需要添加註解
print('hello world') # 這種就不需要註解 - 對於覆雜的操作,應該在操作開始前寫上若幹行註解
- 對於 不是一目了然的代碼,應在其行尾添加註解(為了提高可讀性,註解應該至少離開代碼 2 個空格)
- 絕不要描述代碼,假設閱讀代碼的人比你更懂 Python,他只是不知道你的代碼要做什麽
在一些正規的開发團隊,通常會有 代碼審核 的慣例,就是一個團隊中彼此閱讀對方的代碼
關於代碼規範:
- Python 官方提供有一系列 PEP(Python Enhancement Proposals) 文檔
- 其中第 8 篇文檔專門針對 Python 的代碼格式 給出了建議,也就是俗稱的 PEP 8
- 文檔地址:pep8
- google 有對應的中文文檔:點此連結
任何語言的程序員,編寫出符合規範的代碼,是開始程序生涯的第一步
※最後更新時間:2021-04-16 18:19:42 From:110.30.49.136 By:Mingo