本文內(nèi)容主要介紹了Python代碼注釋規(guī)范代碼實(shí)例解析,通過示例代碼介紹的非常詳細(xì)楣富，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下＜氖琛！灯荧！
一礁击、代碼注釋介紹
注釋就是對代碼的解釋和說明，其目的是讓人們能夠更加輕松地了解代碼。
注釋是編寫程序時(shí)哆窿，寫程序的人給一個(gè)語句链烈、程序段、函數(shù)等的解釋或提示挚躯，能提高程序代碼的可讀性强衡。
在有處理邏輯的代碼中，源程序有效注釋量必須在20％以上码荔。
二漩勤、代碼注釋分類
行注釋：在符號后那一行不會(huì)被編譯（顯示）
塊注釋：被塊注釋符號中間的部分不會(huì)被編譯
三、python代碼注釋基礎(chǔ)
Python中使用#表示單行注釋缩搅。單行注釋可以作為單獨(dú)的一行放在被注釋代碼行之上越败，也可以放在語句或表達(dá)式之后。如下例子：
name = 'xiaohong' # 單行注釋
# 單行注釋name = 'xiaohong'
Python中使用三個(gè)單引號或三個(gè)雙引號表示多行注釋硼瓣。用在注釋多寫不下的情況眉尸，如下例子：
'''這是使用三個(gè)單引號的多行注釋'''
"""這是使用三個(gè)雙引號的多行注釋"""
四、DocStrings介紹與使用
4.1 DocStrings介紹
文檔字符串
是一個(gè)重要工具巨双，用于解釋文檔程序噪猾，幫助你的程序文檔更加簡單易懂
4.2 python中使用DocStrings
在函數(shù)體的第一行使用一對三個(gè)單引號 ''' 或者一對三個(gè)雙引號 """ 來定義文檔字符串。你可以使用 doc（注意雙下劃線）調(diào)用函數(shù)中的文檔字符串屬性筑累。
編寫示例如下：
5.2 Google風(fēng)格
5.3 Numpydoc (Numpy風(fēng)格)
六袱蜡、一些注釋經(jīng)驗(yàn)
注釋不是越多越好。對于一目了然的代碼慢宗，不需要添加注釋坪蚁。
對于復(fù)雜的操作，應(yīng)該在操作開始前寫上相應(yīng)的注釋镜沽。
對于不是一目了然的代碼敏晤，應(yīng)該在代碼之后添加注釋。
絕對不要描述代碼缅茉。一般閱讀代碼的人都了解Python的語法嘴脾，只是不知道代碼要干什么
