函數(shù)
1. 形式：直接在函數(shù)體的最上面集绰，添加三個(gè)雙引號(hào)對(duì)注釋
def 函數(shù)名():
""" 注釋信息 """
2. 注釋信息
(1) 函數(shù)功能
(2) 參數(shù)
1) 含義
2) 類型
3) 是否可以省略
4) 默認(rèn)值
(3) 返回值
1) 含義
2) 類型
3. 示例
def calculate(a, b=1):
"""
計(jì)算兩個(gè)數(shù)據(jù)的和, 以及差
:param a: 數(shù)值1, 數(shù)值類型, 不可選, 沒有默認(rèn)值
:param b: 數(shù)值2, 數(shù)值類型, 可選, 默認(rèn)值: 1
:return: 計(jì)算結(jié)果, 元組: (和十电，差)
"""
value = a + b
number = a - b
return (value, number)
類
1. 形式
(1) 直接在類的下方, 使用三個(gè)雙引號(hào)對(duì)注釋
(2) 需要注明類的作用, 以及類屬性描述
(3) 方法注釋和函數(shù)注釋一樣
2. 示例
class Person:
"""
關(guān)于這個(gè)類的描述, 類的作用, 類構(gòu)造函數(shù), 類屬性等等
Attributes:
count: int 代表人的個(gè)數(shù)
"""
count = 100
def play(self, ball):
"""
這個(gè)方法的作用效果
:param ball: 參數(shù)含義, 參數(shù)類型, 是否可選, 是否有默認(rèn)值
:return: 返回結(jié)果含義, 返回結(jié)果數(shù)據(jù)類型
"""
