pycharm创建py文件之后,使用快捷键自动生成函数注释

问题描述——pycharm里面如何生成函数注释,如下面这样

image.png

问题原因

需要到pycharm里面去设置一下

image.png

解决方法

安装上面进入pycharm设置里面

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

image.png

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

image.png

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:

    """

问题解决,

Logo

魔乐社区(Modelers.cn) 是一个中立、公益的人工智能社区,提供人工智能工具、模型、数据的托管、展示与应用协同服务,为人工智能开发及爱好者搭建开放的学习交流平台。社区通过理事会方式运作,由全产业链共同建设、共同运营、共同享有,推动国产AI生态繁荣发展。

更多推荐