解析Python程式碼註解規範程式碼

一、程式碼註解介紹

• #註解就是對程式碼的解釋和說明，其目的是讓人們能夠更輕鬆地了解程式碼。
• 註解是編寫程式時，寫程式的人給一個語句、程式段、函數等的解釋或提示，能提高程式碼的可讀性。

• 在有處理邏輯的程式碼中，原始程式有效註解量必須在20％以上。

相關學習推薦：python影片教學

#二、程式碼註解分類

行註解：符號後那一行不會被編譯（顯示）

區塊註解：被區塊註解符號中間的部分不會被編譯

三、python程式碼註解基礎

Python中使用#表示單行註解。單行註解可以作為單獨的一行放在被註解程式碼行之上，也可以放在語句或表達式之後。如下範例：

name = 'xiaohong' # 單行註解

# 單行註解
name = 'xiaohong'

#Python中使用三個單引號或三個雙引號表示多行註解。用在註解多寫不下的情況，如下範例：

'''
這是使用三個單引號的多行註解
'''

#"""
這是使用三個雙引號的多行註解
"""

#四、DocStrings介紹與使用

4.1 DocStrings介紹

#文件字串

是一個重要工具，用於解釋文件程序，幫助你的程式文件更簡單易懂

4.2 python中使用DocStrings

在函數體的第一行使用一對三個單引號''' 或一對一個雙引號""" 來定義文檔字串。你可以使用doc（注意雙底線）呼叫函數中的文檔字串屬性。

編寫範例如下：

def add(num1,num2):
  """ 完成传入的两个数之和

  :param num1: 加数1
  :param num2: 加数2
  :return: 和
  """
  return num1 + num2

print( add.__doc__ )

備註：DocStrings文件字串使用慣例：它的首行簡述函數功能，第二行空行，第三行為函數的具體描述。

#。

5.1 reST風格#########這是現在流行的一種風格，reST風格，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風格###

"""
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風格)###

"""
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
"""

#########六、一些註解經驗###############註解不是越多越好。對於一目了然的程式碼，不需要添加註解。######對於複雜的操作，應該在操作開始前寫上相應的註解。######對於不是一目了然的程式碼，應該在程式碼之後加上註解。######絕對不要描述程式碼。一般閱讀程式碼的人都了解Python的語法，只是不知道程式碼要做什麼############相關學習推薦：###程式設計影片##########

以上是解析Python程式碼註解規範程式碼的詳細內容。更多資訊請關注PHP中文網其他相關文章！