python-函數的文檔說明

01- 可以在時間過了很久后 快速讀懂自己的代碼
02- 便於工作的交接

# 函數
def my_func(a, b):
    # 文檔說明
    """

    :param a:
    :param b:
    :return:
    """
    # 單行注釋
    num = 10
    return a + b + num

# 假設 len函數
# 函數的文檔說明 -> 加的文檔說明 是python
# help(len)
# len python內置函數 python創建

# 很多的時候需要程序員自己創建
# 自定義一個函數
def add2num(num1, num2):
    return num1 + num2
help(add2num)  # 如果一個自定義函數 沒有文檔說明 默認是用help會打印函數上面的注釋

# 自定義一個函數
def add2num(num1, num2):
    """
    這個函數是用來計算兩個數的和的
    :param num1: 數字1
    :param num2: 數字2
    :return: 返回值是兩個數字相加
    """
    return num1 + num2
help(add2num)
# 一切靠自覺
# add2num([1, 2], (1, 3))  # 錯誤的

完