在 Python 代碼中,我們可以使用注釋(comment)提高代碼可讀性,告訴別人代碼的意圖。注釋是在程序中添加描述性文字的文本,可以在程序中忽略,不參與運行。
Python 中使用注釋的方法如下:
單行注釋
在一行代碼中,如果需要添加注釋,可以使用井號#符號表示注釋開始,直到行末結束。例如:
# 這是一個單行注釋
print("Hello, world!")
在上述代碼中,使用了單行注釋,井號后面的字串將被忽略,不參與程序的執行。
多行注釋
如果需要添加多個注釋,可以使用三個連續的引號(單引號或雙引號均可)來表示注釋段的開始和結束。例如:
"""
這是一個多行注釋
可以在這里添加注釋內容
"""
print("Hello, world!")
在上述代碼中,使用了多行注釋,三個雙引號之間的內容將全部被忽略,不參與程序的執行。
需要注意的是,注釋不僅可以提高代碼的可讀性和可維護性,還可以幫助我們記錄代碼的邏輯和實現過程,便于日后復查和修改。因此在寫代碼時,盡量添加注釋,使代碼更加易于理解和維護。