品易云推流 关闭
文章详情页
文章 > Pycharm > pycharm注释出错的原因是什么

pycharm注释出错的原因是什么

pycharm

头像

小妮浅浅

2021-01-25 18:41:125930浏览 · 0收藏 · 0评论

本文教程操作环境:windows7系统、Python 3.9.1,DELL G3电脑。

很多人喜欢买一个标签条用来给要点写标注,单独的标签页面也非常显眼。在pycharm中也有类似的注释操作需要我们去进行,有一些小伙伴学习了pycharm注释后去定义函数问题,但是发现不能进行备注。今天我们就pycharm在函数中的注释方法和出错的解决问题统一整理出来,有相关需求的小伙伴可以看看。

PyCharm在定义函数之后,可以自动生成包括参数和返回值在内的注释,具体使用方法为:

函数定义后,另起一行,输入三对引号(单引号和双引号均可),后回车

def f(b,c):
'''

输出结果为

def a(b,c):
 '''
 :param b:
 :param c:
 :return:
 '''


如果是输入输出解释的话,在def()的下面一行(注意缩进)输入三个双引号然后回车 

def xxx(self, x1, x2, x3):
        """
       
        :param x1: 
        :param x2: 
        :param x3: 
        :return: 
        """

但是,最近在使用的时候发现,定义函数之后不能按照此方法自动生成注释。查阅资料发现,原来是 PyCharm 的设置问题,解决方法如下


按照如上1-4的步骤,即在 File -> Settings -> Tools -> Python Integrated Tools -> Docstrings -> Docstring format 中将 Docstring format 改为 reStructuredText,此处如果是 plain 就导致定义函数之后不能自动生成注释。

 

看完本篇文章后的小伙伴会发现,我们一直尝试用pycharm注释函数不成功的原因是因为设置出了问题,学会的小伙伴们赶紧去解决出错吧,没有遇到这类问题的也可以学习解决方法,以备之后的使用。

关注

关注公众号,随时随地在线学习

本教程部分素材来源于网络,版权问题联系站长!

底部广告图