1.註釋的作用
使用自己熟悉的語言,對程序中某些代碼進行標註說明,增強系統的可讀性。
2.單行註釋(行註釋)
- 以
#
開頭,#
右邊的所有東西都被當作說明文字,而不是真正要執行的程序,只起到輔助說明作用:
– 示例代碼如下:
# 這是一個單行註釋
print("hello, world")
- 可在
#
後面添加一個空格,符合代碼格式規範。 - 在pycharm中,若要批量改格式規範,可右鍵代碼處的
小燈泡
圖標,選擇Reformat File
。
2.1在代碼後面增加的單行註釋
- 在程序開發時,同樣可以使用
#
在代碼的後面(旁邊)增加說明性的文字。 - 但是需要注意,爲了保證代碼的可讀性,註釋和代碼之間至少要有兩個空格。
– 示例代碼如下:
print("hello, world") # 輸出 hello world
3.多行註釋(塊註釋)
- 如歌希望編寫的註釋信息很多。一行無法顯示,即可以使用多行註釋。
- 要在python在、程序中使用多行註釋,可以用一對連續的三個引號
(單引號和雙引號都可以)
– 示例代碼如下:
"""
這是一個多行註釋
在多行註釋之間,可以寫很多內容...
"""
print("hello, world")
4. 什麼時候需要註釋
1.註釋不是越多越好,對於一目瞭然的代碼,不需要添加註釋。
2.對於複雜的操作,應該在操作開始前寫上若干行註釋
3.對於不是一目瞭然的代碼,應該在其行尾添加註釋
4.絕不要描述代碼內容
參考資料:b站 黑馬程序員視頻