下面就Python中的注釋做一些演示:單號注釋,多行注釋,文檔注釋
1. 單行注釋
# This is a single line comment in Python
使用# 號,后面的字符串是單行注釋內(nèi)容
2.多行注釋
使用三單引號或三雙引號
"""
This type of comment spans multiple lines.
These are mostly used for documentation of functions, classes and modules.
""
3. 文檔注釋
文檔字符串 - 與常規(guī)注釋不同 - 存儲為它們記錄的函數(shù)的屬性,這意味著你可以以編程方式訪問它們。
例如,先聲明一個(gè)函數(shù),添加文檔注釋
def Add(x, y):
"""
? ? 計(jì)算2個(gè)輸入數(shù)的和
? ? :param x:第一個(gè)加數(shù)
? ? :param y:第二個(gè)加數(shù)
? ? :return:返回和值"""
? ? return x+y
使用函數(shù)的__doc__屬性獲取文檔注釋
print(Add.__doc__)
輸出:
? ? 計(jì)算2個(gè)輸入數(shù)的和
? ? :param x:第一個(gè)加數(shù)
? ? :param y:第二個(gè)加數(shù)
? ? :return:返回和值