小编给大家分享一下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中为什么会注释出错”这篇文章的所有内容,感谢各位的阅读!相信大家都有了一定的了解,希望分享的内容对大家有所帮助,如果还想学习更多知识,欢迎关注亿速云行业资讯频道!
免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。