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中使用SQLAlchemy查询PostgreSQL视图的流程步骤
作为软件开发人员,查询 PostgreSQL 视图是一项常见任务,使用视图（代表SQL 查询输出的虚拟表）被认为是处理关系数据库时的有效方法,本文介绍如何在 Python 中使用 SQLAlchemy 查询 PostgreSQL 视图,需要的朋友可以参考下
2023-09-09
pytorch 膨胀算法实现大眼效果
在PS中，我们可以利用液化工具对人像进行瘦脸、放大眼睛等系列的常规操作。今天我们来了解一下这些操作的算法原理，并用pytorch 膨胀算法来实现大眼效果，感兴趣的可以了解一下
2021-11-11
Python单链表简单实现代码
这篇文章主要介绍了Python单链表简单实现代码,结合实例形式分析了Python单链表的具体定义与功能实现技巧,需要的朋友可以参考下
2016-04-04
Python分割单词和转换命名法的实现
本文主要介绍了Python分割单词和转换命名法的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2023-03-03
python替换字符串中的子串图文步骤
在本文里小编给大家整理了关于python替换字符串中的子串的相关知识点以及实际操作步骤，有需要的朋友们学习下。
2019-06-06
手把手带你了解Python数据分析--matplotlib
这篇文章主要介绍了Python实现matplotlib显示中文的方法,结合实例形式详细总结分析了Python使用matplotlib库绘图时显示中文的相关操作技巧与注意事项,需要的朋友可以参考下
2021-08-08
Python中str.format()方法的具体使用
本文主要介绍了Python中str.format()方法的具体使用，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-09-09
简述Python2与Python3的不同点
在Python2和Python3中都提供print()方法来打印信息,但两个版本间的print稍微有差异。下面通过本文给大家介绍Python2与Python3的不同点，需要的朋友参考下
2018-01-01
Python GUI之tkinter详解
今天带大家学习Python GUI之tkinter的相关知识,文中对如何使用tkinter作了非常详细的介绍及代码示例,对正在学习python的小伙伴们有很好的帮助,需要的朋友可以参考下
2021-10-10
Python读取MRI并显示为灰度图像实例代码
这篇文章主要介绍了Python读取MRI并显示为灰度图像实例代码，具有一定借鉴价值,需要的朋友可以参考下
2018-01-01