Python 注釋
目標(biāo)
在本文章中旬蟋，你將學(xué)習(xí)如何向代碼添加注釋。你將學(xué)習(xí)各種類型的Python注釋殴玛，包括塊注釋、內(nèi)聯(lián)注釋和文檔字符串添祸。
Python注釋簡介
有時滚粟，你希望記錄編寫的代碼。例如刃泌，你可能想要說明為什么一段代碼可以工作凡壤。要做到這一點署尤，可以使用注釋。
通常亚侠，你可以使用注釋來解釋公式曹体、算法和復(fù)雜的業(yè)務(wù)邏輯。
在執(zhí)行程序時硝烂，Python解釋器會忽略注釋箕别，只解釋代碼。
Python提供了三種注釋滞谢，包括塊注釋串稀、內(nèi)聯(lián)注釋和文檔字符串。
Python塊注釋
塊注釋解釋它后面的代碼狮杨。通常母截，你將代碼塊注釋縮進(jìn)到與代碼塊相同的級別。
要創(chuàng)建塊注釋禾酱，首先使用一個井號(#)微酬，然后是一個空格和一個文本字符串绘趋。例如:
# 價格增加5%
price = price * 1.05
Python內(nèi)聯(lián)注釋
當(dāng)你將注釋放在語句的同一行時颤陶，你將擁有一個內(nèi)聯(lián)注釋。
與塊注釋類似陷遮，內(nèi)聯(lián)注釋以一個井號(#)開頭滓走，后面跟著一個空格和一個文本字符串。
下面的例子演示了一個內(nèi)聯(lián)注釋:
salary = salary * 1.02 # 增加工資2%
Python文檔字符串
文檔字符串是放在代碼塊(例如函數(shù))的第一行的字符串字面量帽馋。
與常規(guī)注釋不同搅方，文檔字符串可以在運行時使用obj.doc屬性訪問，其中obj是函數(shù)名绽族。
通常姨涡，您可以使用文檔字符串自動生成代碼文檔。
文檔字符串稱為文檔字符串吧慢。
從技術(shù)上講涛漂，文檔字符串不是注釋。它們創(chuàng)建引用字符串的匿名變量检诗。而且匈仗，它們不會被Python解釋器忽略。
Python提供兩種文檔字符串:單行文檔字符串和多行文檔字符串逢慌。
1)單行文檔字符串
顧名思義悠轩，單行文檔字符串適合一行。單行文檔字符串以三重引號(""")開頭攻泼，也以三重引號(""")結(jié)尾火架。此外鉴象，在單行文檔字符串之前和之后都不會有任何空行。
下面的例子演示了quicksort()函數(shù)中的單行文檔字符串:
def quicksort():
"""使用快速排序算法對列表進(jìn)行排序"""
...
2)多行文檔字符串
與單行文檔字符串不同何鸡，多行文檔字符串可以跨多行炼列。多行文檔字符串也以三重引號(""")開始，以三重引號(""")結(jié)束音比。
下面的例子展示了如何使用多行文檔字符串:
def increase(salary, percentage, rating):
"""
按評級和百分比增加工資
級別 1 - 2 不增加
級別 3 - 4 增加 5%
級別 4 - 6 增加 10%
"""
Python多行注釋
Python不支持多行注釋俭尖。
但是，你可以使用多行文檔字符串作為多行注釋洞翩。Python的創(chuàng)建者Guido van Rossum也推薦這種方法稽犁。
讓你的注釋保持清晰、簡潔和解釋性是一個很好的做法骚亿。最終目標(biāo)是為你和其他稍后將處理代碼的開發(fā)人員節(jié)省時間和精力已亥。
總結(jié)
- 必要時使用注釋來記錄代碼。
- 塊注釋和內(nèi)聯(lián)注釋以#開頭来屠。
- 對函數(shù)虑椎、模塊和類使用文檔字符串。
