pycharm自动生成函数注释及注意事项

不少博客都说过怎么生成注释，但是照着别人的博客自己实践不少次才成功，简单记录下

首先，检查pycharm的设置：

如果这里是plain的话，需要先改成其他的选项

其次，假如有个函数如下：

def func(a, b, c):

就可以直接在func的下面输入输入三个单引号 / 双引号：

def func(a, b, c):
	'''
	# 或者是
	"""
	# pycharm里面，输入三个单引号 / 双引号之后会自动补充对应的三个，这不影响

一定要注意，在3个单引号或者3个双引号的前面，有一个tab键的空间，就是python语法里一个缩进。我之前就是没有加tab就一直没有出来自动生成的代码注释
然后再按回车键即可

不过根据python的PEP规范，文档字符串（docstrings）推荐使用双引号

pycharm里面自带的有四种代码注释的风格：

1.Epytext

def func(a, b, c):
    """
    
    @param a:
    @param b:
    @param c:
    @return:
    """

2.restructedText

def func(a, b, c):
    """
    
    :param a: 
    :param b: 
    :param c: 
    :return: 
    """

3.Numpy

def func(a, b, c):
    """
    
    Parameters
    ----------
    a
    b
    c

    Returns
    -------

    """

4.Google

def func(a, b, c):
    """
    
    Args:
        a: 
        b: 
        c: 

    Returns:

    """