本文內容主要介紹了Python代碼注釋規范代碼實例解析,通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下！！！

一、代碼注釋介紹

注釋就是對代碼的解釋和說明，其目的是讓人們能夠更加輕松地了解代碼。

注釋是編寫程序時，寫程序的人給一個語句、程序段、函數等的解釋或提示，能提高程序代碼的可讀性。

在有處理邏輯的代碼中，源程序有效注釋量必須在20％以上。

二、代碼注釋分類

行注釋：在符號后那一行不會被編譯(顯示)

塊注釋：被塊注釋符號中間的部分不會被編譯

三、python代碼注釋基礎

Python中使用#表示單行注釋。單行注釋可以作為單獨的一行放在被注釋代碼行之上，也可以放在語句或表達式之后。如下例子：

name = 'xiaohong' # 單行注釋

# 單行注釋name = 'xiaohong'

Python中使用三個單引號或三個雙引號表示多行注釋。用在注釋多寫不下的情況，如下例子：

'''這是使用三個單引號的多行注釋'''

"""這是使用三個雙引號的多行注釋"""

四、DocStrings介紹與使用

4.1 DocStrings介紹

文檔字符串

是一個重要工具，用于解釋文檔程序，幫助你的程序文檔更加簡單易懂

4.2 python中使用DocStrings

在函數體的第一行使用一對三個單引號 ''' 或者一對三個雙引號 """ 來定義文檔字符串。你可以使用 doc(注意雙下劃線)調用函數中的文檔字符串屬性。

編寫示例如下：

5.2 Google風格

5.3 Numpydoc (Numpy風格)

六、一些注釋經驗

注釋不是越多越好。對于一目了然的代碼，不需要添加注釋。

對于復雜的操作，應該在操作開始前寫上相應的注釋。

對于不是一目了然的代碼，應該在代碼之后添加注釋。

絕對不要描述代碼。一般閱讀代碼的人都了解Python的語法，只是不知道代碼要干什么

總結

以上是生活随笔為你收集整理的python代码大全中文注释_零基础小白必看篇：Python代码注释规范代码实例解析操作（收藏）...的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。