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----------abcReturns-------"""

4.Google

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

pycharm自动生成函数注释及注意事项相关推荐

[python]pycharm自动生成函数注释
函数涉及到多个参数的时候注释是一个不可或缺的好帮手,手动生成参数又是一件比较费事的事情,我们能想到的pycharm也替我们想到了,并给出了比较不错的解决方案,一次设置长期有效: 设置方法也比较简单: ...
PyCharm 不能自动生成函数注释
PyCharm 中可以在新建文件自动生成文件头注释,实现自动生成运行环境,作者.日期等必要信息,使用比较方便,配置十分简单,具体设置可参考这篇博客. 另外,PyCharm在定义函数之后,可以自动生成包 ...
pycharm 自动函数注释
pycharm 自动函数注释
解决Pycharm不能自动生成函数注释
PyCharm在定义函数之后,可以自动生成包括参数和返回值在内的注释,具体使用方法为: 函数定义后,另起一行,输入三对引号(单引号和双引号均可),后回车 def f(b,c): ''' 输出结果为 d ...
pycharm自动生成函数调用图
pycharm自动生成函数调用图 1.下载并安装graphviz 1.1 下载链接:https://graphviz.gitlab.io/_pages/Download/windowshiyo那个s/ ...
java自动生成函数注释_IDEA类和方法注释自动生成（2019-08-31 21:47写）
1. 生成类注释打开Preferences-->Editor-->File and Code Templates,右侧选择Filestab页,找到Class.Interface,可以看到 ...
pycharm 自动生成文件注释和函数注释
1. 文件注释 pycharm提供了一个在新建文件自动生成文件头注释的功能,可以实现自动生成运行环境,作者.日期等必要信息,使用比较方便,配置十分简单.在anaconda 的spider也有类似的功能 ...
Pycharm工具Python开发自动添加注释（详细）
方法自动添加注释定义了一个函数,在函数下面敲入了三个双引号后,enter回车并没有自动出现注释,如图: 解决办法 Pycharm中依次打开File -> Settings -> Tool ...
PyCharm自动格式化代码
PyCharm自动格式化代码在我们使用PyCharm编写代码的过程中,难免会存在一些格式上的不规范行为,比如:注释#后面要加空格,空行等等.那么下面就介绍一下PyCharm中自动规范代码格式方法. ...

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

pycharm自动生成函数注释及注意事项相关推荐

最新文章

热门文章