pycharm - 自動添加函數注釋和文件注釋

1. 自動添加文件注釋

在pycharm中設置，非常簡單，如下：

2. 自動生成函數注釋，包括參數和返回值

在函數定義時，直接輸入三個雙引號后回車，如下：

def my_add(a, b):
    """
    
    :param a: 加數1
    :param b: 加數2
    :return: 兩個參數之和
    """
    c = a + b
    return c

 

 

文件注釋+函數注釋：

# @Time    : 2020/10/2 5:23 下午
# @Author  : zhangyang
# @File    : gvh.py


def my_add(a, b):
    """

    :param a: 加數1
    :param b: 加數2
    :return: 兩個參數之和
    """
    c = a + b
    return c