pycharm如何为函数插入文档注释

更新时间：2022年02月10日 11:37:28 作者：大奸猫

这篇文章主要介绍了pycharm如何为函数插入文档注释，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教

pycharm为函数插入文档注释

S1 光标放在函数名上方，点击小灯泡，出现菜单

S2 选择 input documentation string stub ，即插入文档注释

在这里插入图片描述

S3 输入函数的各参数注释，返回值注释

在这里插入图片描述

pycharm函数注释简单设置

在安装PyCharm后可能存在函数自动注释无法使用的情况。

可以按照以下路径：File->Settings->Tools->Python Intrgrated Tools->Docstrings->Docstring format 进行修改

将Plain换为其他的任意模板，这里使用Goole，当然也可以自己创建模板

Plain可能无法使用，可以选择其他模板。推荐使用Google

修改后，在函数下方输入三个 " 回车就会自动添加相应格式的注释

'''
@Project : python
@File    : TEST
@Author  : threeegg@foxmail.com
@Data    : 2021/3/22 10:26
'''
def newfunc(a,b):
    """
    Args:
        a:
        b:
    Returns:
    """
    pass

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

tkinter高级布局之PanedWindow和notebook详解
本文主要介绍了tkinter中的两种布局控件,分别是可以动态划分子控件的PanedWindow,和提供了选项卡工具的notebook,感兴趣的小伙伴可以学习一下
2023-08-08
django 使用 PIL 压缩图片的例子
今天小编就为大家分享一篇django 使用 PIL 压缩图片的例子，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2019-08-08
python清除字符串里非字母字符的方法
这篇文章主要介绍了python清除字符串里非字母字符的方法,涉及Python字符串正则替换操作的相关技巧,需要的朋友可以参考下
2015-07-07
Python中三个不可思议的返回功能分享
这篇文章主要给大家介绍了Python中三个不可思议的返回功能,文中通过实例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2022-01-01
PyTorch中permute的用法详解
今天小编就为大家分享一篇PyTorch中permute的用法详解，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2019-12-12
Python删除指定目录下过期文件的2个脚本分享
这篇文章主要介绍了Python删除指定目录下过期文件2个脚本分享,可以用在如删除指定日期前的日志文件,需要的朋友可以参考下
2014-04-04
详解Python使用simplejson模块解析JSON的方法
这篇文章主要介绍了Python使用simplejson模块解析JSON的方法,实例代码基于Pyhton2.x版本,文中最后还附了关于simplejson模块的一些性能放面的讨论,需要的朋友可以参考下
2016-03-03
使用Python设置,更新和获取Excel单元格的值
Excel工作簿作为一款广泛使用的数据管理工具,与Python相结合,可以使得自动化处理大量数据成为可能,本文将演示如何使用Python设置、更新以及获取Excel文件中单元格的值,希望对大家有所帮助
2024-10-10
Python数据可视化之matplotlib.pyplot绘图的基本参数详解
matplotlib.pyplot模块是一个功能强大的画图模块,可以对画图的多个参数进行调整,下面这篇文章主要给大家介绍了关于Python数据可视化之matplotlib.pyplot绘图基本参数的相关资料,需要的朋友可以参考下
2022-04-04
解决python "No module named pip"的问题
今天小编就为大家分享一篇解决python "No module named pip"的问题。具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2018-10-10