在 Python 中,可以使用以下方式注釋代碼:
1. 單行注釋:使用 "#" 符號來注釋單行代碼。在 "#" 符號后面的內容將被解釋器忽略。例如:
# 這是一個單行注釋
print("Hello, World!") # 這是另一個單行注釋
2. 多行注釋:使用三個引號(""")或三個單引號(''')來注釋多行代碼塊。這種注釋方式可以用于注釋多行的代碼片段或者文檔字符串(docstring)。例如:
"""
這是一個多行注釋
可以注釋多行代碼塊
"""
'''
這也是一個多行注釋
可以注釋多行代碼塊
'''
3. 注釋代碼塊:如果你需要注釋一段代碼塊,可以使用單行注釋或多行注釋來注釋每一行。例如:
# 下面是一段代碼塊的注釋
# print("Hello, World!")
# print("Welcome to Python!")
4. 文檔字符串(docstring):文檔字符串是一個特殊的注釋形式,用于對函數、類或模塊進行文檔說明。它通常位于函數、類或模塊的開頭,并使用三個引號(""")或三個單引號(''')包裹。例如:
def add(a, b):
"""
這是一個加法函數
參數:a,b為兩個數值
返回值:a和b的和
"""
return a + b
以上是 Python 中常用的注釋方式。注釋是一種良好的編程習慣,可以提高代碼的可讀性和可維護性。合適的注釋可以幫助他人理解代碼的意圖,并在需要時方便自己回顧代碼邏輯。