您好,登錄后才能下訂單哦!
小編給大家分享一下Python中注釋規(guī)范代碼的案例分析,相信大部分人都還不怎么了解,因此分享這篇文章給大家參考一下,希望大家閱讀完這篇文章后大有收獲,下面讓我們一起去了解一下吧!
一、代碼注釋介紹
二、代碼注釋分類
行注釋:在符號(hào)后那一行不會(huì)被編譯(顯示)
塊注釋:被塊注釋符號(hào)中間的部分不會(huì)被編譯
三、python代碼注釋基礎(chǔ)
Python中使用#表示單行注釋。單行注釋可以作為單獨(dú)的一行放在被注釋代碼行之上,也可以放在語句或表達(dá)式之后。如下例子:
name = 'xiaohong' # 單行注釋
# 單行注釋
name = 'xiaohong'
Python中使用三個(gè)單引號(hào)或三個(gè)雙引號(hào)表示多行注釋。用在注釋多寫不下的情況,如下例子:
'''
這是使用三個(gè)單引號(hào)的多行注釋
'''"""
這是使用三個(gè)雙引號(hào)的多行注釋
"""
四、DocStrings介紹與使用
4.1 DocStrings介紹
文檔字符串
是一個(gè)重要工具,用于解釋文檔程序,幫助你的程序文檔更加簡(jiǎn)單易懂
4.2 python中使用DocStrings
在函數(shù)體的第一行使用一對(duì)三個(gè)單引號(hào) ''' 或者一對(duì)三個(gè)雙引號(hào) """ 來定義文檔字符串。你可以使用 doc(注意雙下劃線)調(diào)用函數(shù)中的文檔字符串屬性。
編寫示例如下:
def add(num1,num2): """ 完成傳入的兩個(gè)數(shù)之和 :param num1: 加數(shù)1 :param num2: 加數(shù)2 :return: 和 """ return num1 + num2 print( add.__doc__ )
備注:DocStrings 文檔字符串使用慣例:它的首行簡(jiǎn)述函數(shù)功能,第二行空行,第三行為函數(shù)的具體描述。
五、DocStrings常用編寫風(fēng)格
5.1 reST風(fēng)格
這是現(xiàn)在流行的一種風(fēng)格,reST風(fēng)格,Sphinx的御用格式,比較緊湊。
""" This is a reST style. :param param1: this is a first param :param param2: this is a second param :returns: this is a description of what is returned :raises keyError: raises an exception """
5.2 Google風(fēng)格
""" This is a groups style docs. Parameters: param1 - this is the first param param2 - this is a second param Returns: This is a description of what is returned Raises: KeyError - raises an exception """
5.3 Numpydoc (Numpy風(fēng)格)
""" My numpydoc description of a kind of very exhautive numpydoc format docstring. Parameters ---------- first : array_like the 1st param name `first` second : the 2nd param third : {'value', 'other'}, optional the 3rd param, by default 'value' Returns ------- string a value in a string Raises ------ KeyError when a key error OtherError when an other error """
六、一些注釋經(jīng)驗(yàn)
以上是Python中注釋規(guī)范代碼的案例分析的所有內(nèi)容,感謝各位的閱讀!相信大家都有了一定的了解,希望分享的內(nèi)容對(duì)大家有所幫助,如果還想學(xué)習(xí)更多知識(shí),歡迎關(guān)注億速云行業(yè)資訊頻道!
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如果涉及侵權(quán)請(qǐng)聯(lián)系站長(zhǎng)郵箱:is@yisu.com進(jìn)行舉報(bào),并提供相關(guān)證據(jù),一經(jīng)查實(shí),將立刻刪除涉嫌侵權(quán)內(nèi)容。