注释就类似于一种标记,养成良好的注释习惯,可以让我们的代码易读,Pycharm中的有好几种方式,可以针对不同的情况进行使用,但是注释不能随便使用符号来操作,不然就会出现问题,最近有很多的小伙伴在注释上出现了错误,也不知道出错的原因,下面我们一起来看看这篇文章吧,希望可以对大家的学习带来帮助。

Pycharm中为什么会注释出错?Pycharm注释出错的原因是什么?

很在一个单独的界面中,有很多的小伙伴喜欢用一个棉签条来写标注,在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中,在界面的顶部找到菜单栏,点击“file”选项,在下拉的菜单中选择“settings”。

2、进入到settings界面,选择左边的tools选项,打开之后找到Python Integrated Tools,看到右侧的界面,找到子选项Docstrings下的 Docstring format 中将Docstring format 改为reStructuredText即可,就可以在定义函数之后自动生成注释。

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

更多python相关文章请访问分类:python

【版权声明】本文图文出自大盘站@dapan.cc,转载请注明出处!