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

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

您可能感兴趣的文章:

Python基础详解之列表复制
这篇文章主要介绍了Python基础详解之列表复制,文中有非常详细的代码示例,对正在学习python基础的小伙伴们有很好的帮助,需要的朋友可以参考下
2021-04-04
python基础教程之元组操作使用详解
这篇文章主要介绍了python的元组操作使用方法,需要的朋友可以参考下
2014-03-03
安装conda搭建python环境保姆级教程(超详细!)
这篇文章主要给大家介绍了关于安装conda搭建python环境保姆级教程的相关资料,conda可以理解为一个工具,也是一个可执行命令,其核心功能是包管理和环境管理,需要的朋友可以参考下
2023-11-11
Python实现模拟分割大文件及多线程处理的方法
这篇文章主要介绍了Python实现模拟分割大文件及多线程处理的方法,涉及Python文件读取、分割及多线程相关操作技巧,需要的朋友可以参考下
2017-10-10
Numpy数组array和矩阵matrix转换方法
这篇文章主要介绍了Numpy数组array和矩阵matrix转换方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2019-08-08
Python pandas索引的设置和修改方法
索引的作用相当于图书的目录，可以根据目录中的页码快速找到所需的内容,下面这篇文章主要给大家介绍了关于Python pandas索引的设置和修改的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
2022-06-06
Django 拼接两个queryset 或是两个不可以相加的对象实例
这篇文章主要介绍了Django 拼接两个queryset 或是两个不可以相加的对象实例，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2020-03-03
关于PyTorch环境配置及安装教程(Windows10)
这篇文章主要介绍了关于PyTorch环境配置及安装教程(Windows10)，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-07-07
python实现俄罗斯方块游戏
这篇文章主要为大家介绍了python实现俄罗斯方块游戏的详细代码，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2018-06-06
用python实现操纵mysql数据库插入
大家好，本篇文章主要讲的是用python实现操纵mysql数据库插入，感兴趣的同学赶快来看一看吧，对你有帮助的话记得收藏一下
2022-01-01