Python中的注釋和文檔

下面就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:返回和值

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容