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