当前位置： 首页 > news >正文

PyCharm添加自动函数文档注释

news 2026/2/9 22:01:36

目录

    • 1、背景
    • 2、开启PyCharm自动函数文档注释



1、背景


规范的函数文档注释有助于他人理解代码，便于团队协作、提高效率。但如果我们自己手写函数文档注释将非常耗时耗力。PyCharm安装后默认没有开启自动化函数文档注释，需要我们开启

2、开启PyCharm自动函数文档注释


开启步骤：File -> Settings -> Tools -> Python Integrated Tools -> Docstrings -> Docstring format

在这里插入图片描述

Docstring format包括五种风格：Plain（默认）、Epytext、reStructuredText、NumPy和Google

其中，常用的是Epytext和reStructuredText风格

1） Epytext效果：

def docstrings(param1, param2):"""Epytext风格@param param1:@param param2:@return:"""...

2） reStructuredText效果：

def docstrings(param1, param2):"""reStructuredText风格:param param1::param param2::return:"""...

相关文章：

PyCharm添加自动函数文档注释

目录 1、背景2、开启PyCharm自动函数文档注释 1、背景 规范的函数文档注释有助于他人理解代码，便于团队协作、提高效率。但如果我们自己手写函数文档注释将非常耗时耗力。PyCharm安装后默认没有开启自动化函数文档注释，需要我们开启 2、开启PyCharm自动…...

编程日记 2023/12/21 7:40:42

数字图像处理 基于Numpy、PyTorch在频率空间中建模运动模糊

一、简述 运动模糊在图像中很常见，它会降低图像的价值，因为它会破坏图像中包含的数据。在计算机视觉中，通常通过使用许多不同的模糊增强来训练神经网络以适应这种模糊。建模模糊或图像退化的概念来自图像恢复，这是逆转退化影响的过程，以便人类或算法可以辨别原始捕获的数据…...

编程日记 2023/12/21 7:39:40

海康威视对讲广播系统 RCE漏洞复现(CVE-2023-6895)

0x01 产品简介 Hikvision Intercom Broadcasting System是中国海康威视（Hikvision）公司的一个对讲广播系统。 0x02 漏洞概述 Hikvision Intercom Broadcasting System 3.0.3_20201113_RELEASE(HIK)版本存在操作系统命令注入漏洞，该漏洞源于文件/php/ping.php的参数jsonda…...

编程日记 2023/12/21 7:36:38

【优化】Springboot 修改 tomcat连接池

【优化】Springboot 修改 tomcat连接池 factory.setTomcatProtocolHandlerCustomizers(tomcatProtocolHandlerCustomizers); 可以更换为 虚拟线程连接池 package org.config.init;import org.apache.catalina.Context; import org.apache.catalina.core.AprLifecycleListener…...

编程日记 2023/12/21 7:35:37

百度侯震宇：AI原生与大模型将从三个层面重构云计算

12月20日，2023百度云智大会智算大会在北京举办，大会以「大模型重构云计算，Cloud for AI」为主题，深度聚焦大模型引发的云计算变革。 百度智能云表示，为满足大模型落地需求，正在基于「云智一体」战略重构…...

编程日记 2023/12/21 7:34:36

【SpringBoot快速入门】(2)SpringBoot的配置文件与配置方式详细讲解

之前我们已经学习的Spring、SpringMVC、Mabatis、Maven，详细讲解了Spring、SpringMVC、Mabatis整合SSM的方案和案例，上一节我们学习了SpringBoot的开发步骤、工程构建方法以及工程的快速启动，从这一节开始，我们开始学习SpringBoot…...

编程日记 2023/12/21 7:31:33

麒麟V10 ARM 离线生成RabbitMQ docker镜像并上传Harbor私有仓库

第一步在外网主机执行： docker pull arm64v8/rabbitmq:3.8.9-management 将下载的镜像打包给离线主机集群使用 在指定目录下执行打包命令： 执行： docker save -o rabbitmq_arm3.8.9.tar arm64v8/rabbitmq:3.8.9-management 如果懒得打包…...

编程日记 2023/12/21 7:26:29

AI创作系统ChatGPT商业运营网站系统源码，支持AI绘画，GPT语音对话+DALL-E3文生图

一、前言 SparkAi创作系统是基于ChatGPT进行开发的Ai智能问答系统和Midjourney绘画系统，支持OpenAI-GPT全模型国内AI全模型。本期针对源码系统整体测试下来非常完美，可以说SparkAi是目前国内一款的ChatGPT对接OpenAI软件系统。那么如何搭建部署AI创作Ch…...

编程日记 2023/12/21 7:24:28

剑指offer题解合集——Week1day5

剑指offerWeek1 周五：重建二叉树 题目链接：重建二叉树 输入一棵二叉树前序遍历和中序遍历的结果，请重建该二叉树。注意:二叉树中每个节点的值都互不相同； 输入的前序遍历和中序遍历一定合法； 数据范围 树中节点数量…...

编程日记 2023/12/21 7:23:25

Redis设计与实现之数据库

目录 一、数据库 1、数据库的结构 2、 数据库的切换 3、 数据库键空间 4、键空间的操作 添加新键 删除键 更新键 取值 其他操作 5、 键的过期时间 6、过期时间的保存 7、设置生存时间 8、过期键的判定 9、 过期键的清除 定时删除 惰性删除 定期删除 10、过期…...

编程日记 2023/12/21 7:22:24

如何在Eclipse中安装WindowBuilder插件，详解过程

第一步：找到自己安装eclipse的版本，在Help-关于eclipse里面，即Version 第二步：去下面这个网站找到对应的 link（Update Site），这一步很重要，不然版本下载错了之后还得删除WindowBuil…...

编程日记 2023/12/21 7:21:23

node.js mongoose schemaTypes

目录 官方文档 简介 SchemaType 示例 配置SchemaType规则 通用规则 特定schemaType规则 String Number Date Map monggose会根据shcemaType将文档值转换成指定的类型 官方文档 Mongoose v8.0.3: SchemaTypes 简介 SchemaTypes是在使用Mongoose时，用于…...

编程日记 2023/12/21 7:20:21

论文解读：On the Integration of Self-Attention and Convolution

自注意力机制与卷积结合：On the Integration of Self-Attention and Convolution(CVPR2022) 引言 1：卷积可以接受比较大的图片的，但自注意力机制如果图片特别大的话，运算规模会特别大，即上图中右边(卷积)会算得比较快…...

编程日记 2023/12/21 7:18:19

【Spring】15 ApplicationContextAware 接口

文章目录 1. 简介2. 作用3. 使用3.1 创建并实现接口3.2 配置 Bean 信息3.3 创建启动类3.4 启动 4. 应用场景总结 Spring 框架提供了许多回调接口，用于在 Bean 的生命周期中执行特定的操作。ApplicationContextAware 接口是其中之一，它允许 Bean 获取对 A…...

编程日记 2023/12/21 7:11:14

Android 版本控制工具--Git

要在Android中使用Git，需要进行以下步骤： 安装Git：首先在你的开发环境中安装Git。在Windows中，你可以从官方网站（https://git-scm.com/downloads）上下载Git的可执行文件并进行安装。在Mac上，你可…...

编程日记 2023/12/21 7:08:11

Wireshark高级网络安全分析

第一章：Wireshark基础及捕获技巧 1.1 Wireshark基础知识回顾 1.2 高级捕获技巧：过滤器和捕获选项 1.3 Wireshark与其他抓包工具的比较 第二章：网络协议分析 2.1 网络协议分析：TCP、UDP、ICMP等 2.2 高级协议分析：HTTP…...

编程日记 2023/12/21 7:06:09

llvm后端之DAG设计

llvm后端之DAG设计 引言1 核心类设计2 类型系统2.1 MVT::SimpleValueType2.2 MVT2.3 EVT 3 节点类型 引言 llvm后端将中端的IR转为有向无环图，即DAG。如下图： 图中黑色箭头为数据依赖；蓝色线和红色线为控制依赖。蓝色表示指令序列化时两个节…...

编程日记 2023/12/21 7:03:07

反序列化 [SWPUCTF 2021 新生赛]ez_unserialize

打开题目 查看源代码 得到提示&#xff0c;那我们用御剑扫描一下看看 我们知道有个robots.txt&#xff0c;访问一下得到 那我们便访问一下 cl45s.php看看 得到网站源代码 <?phperror_reporting(0); show_source("cl45s.php");class wllm{public $admin;public …...

编程日记 2023/12/21 7:01:05

centos(linux)安装jenkins

官网&#xff1a;https://pkg.jenkins.io/redhat/ 安装官网进行操作&#xff1a; sudo wget -O /etc/yum.repos.d/jenkins.repo https://pkg.jenkins.io/redhat/jenkins.reposudo rpm --import https://pkg.jenkins.io/redhat/jenkins.io-2023.key若出现如下错误&#xff1a; …...

编程日记 2023/12/21 6:54:59

Wireshark统计和可视化

第一章&#xff1a;Wireshark基础及捕获技巧 1.1 Wireshark基础知识回顾 1.2 高级捕获技巧&#xff1a;过滤器和捕获选项 1.3 Wireshark与其他抓包工具的比较 第二章&#xff1a;网络协议分析 2.1 网络协议分析&#xff1a;TCP、UDP、ICMP等 2.2 高级协议分析&#xff1a;HTTP…...

编程日记 2023/12/21 6:53:58

[特殊字符] 智能合约中的数据是如何在区块链中保持一致的？

&#x1f9e0; 智能合约中的数据是如何在区块链中保持一致的&#xff1f; 为什么所有区块链节点都能得出相同结果&#xff1f;合约调用这么复杂&#xff0c;状态真能保持一致吗&#xff1f;本篇带你从底层视角理解“状态一致性”的真相。 一、智能合约的数据存储在哪里&#xf…...

编程新知 2025/10/25 17:23:41

挑战杯推荐项目

“人工智能”创意赛 - 智能艺术创作助手&#xff1a;借助大模型技术&#xff0c;开发能根据用户输入的主题、风格等要求&#xff0c;生成绘画、音乐、文学作品等多种形式艺术创作灵感或初稿的应用&#xff0c;帮助艺术家和创意爱好者激发创意、提高创作效率。 ​ - 个性化梦境…...

编程新知 2025/11/6 5:46:16

椭圆曲线密码学(ECC)

一、ECC算法概述 椭圆曲线密码学&#xff08;Elliptic Curve Cryptography&#xff09;是基于椭圆曲线数学理论的公钥密码系统&#xff0c;由Neal Koblitz和Victor Miller在1985年独立提出。相比RSA&#xff0c;ECC在相同安全强度下密钥更短&#xff08;256位ECC ≈ 3072位RSA…...

编程新知 2025/10/1 22:26:06

STM32+rt-thread判断是否联网

一、根据NETDEV_FLAG_INTERNET_UP位判断 static bool is_conncected(void) {struct netdev *dev RT_NULL;dev netdev_get_first_by_flags(NETDEV_FLAG_INTERNET_UP);if (dev RT_NULL){printf("wait netdev internet up...");return false;}else{printf("loc…...

编程新知 2025/9/23 20:06:08

visual studio 2022更改主题为深色

visual studio 2022更改主题为深色 点击visual studio 上方的 工具-> 选项 在选项窗口中&#xff0c;选择 环境 -> 常规 &#xff0c;将其中的颜色主题改成深色 点击确定&#xff0c;更改完成...

编程新知 2026/1/25 11:13:37

【JVM】- 内存结构

引言 JVM&#xff1a;Java Virtual Machine 定义&#xff1a;Java虚拟机&#xff0c;Java二进制字节码的运行环境好处&#xff1a; 一次编写&#xff0c;到处运行自动内存管理&#xff0c;垃圾回收的功能数组下标越界检查&#xff08;会抛异常&#xff0c;不会覆盖到其他代码…...

编程新知 2026/1/30 13:40:43

镜像里切换为普通用户

如果你登录远程虚拟机默认就是 root 用户&#xff0c;但你不希望用 root 权限运行 ns-3&#xff08;这是对的&#xff0c;ns3 工具会拒绝 root&#xff09;&#xff0c;你可以按以下方法创建一个 非 root 用户账号 并切换到它运行 ns-3。 一次性解决方案&#xff1a;创建非 roo…...

编程新知 2025/9/11 11:00:29

CocosCreator 之 JavaScript/TypeScript和Java的相互交互

引擎版本&#xff1a; 3.8.1 语言&#xff1a; JavaScript/TypeScript、C、Java 环境&#xff1a;Window 参考&#xff1a;Java原生反射机制 您好&#xff0c;我是鹤九日&#xff01; 回顾 在上篇文章中&#xff1a;CocosCreator Android项目接入UnityAds 广告SDK。 我们简单讲…...

编程新知 2026/1/30 12:10:19

ElasticSearch搜索引擎之倒排索引及其底层算法

文章目录 一、搜索引擎1、什么是搜索引擎？2、搜索引擎的分类3、常用的搜索引擎4、搜索引擎的特点二、倒排索引1、简介2、为什么倒排索引不用B+树1.创建时间长，文件大。2.其次，树深，IO次数可怕。3.索引可能会失效。4.精准度差。三. 倒排索引四、算法1、Term Index的算法2、 …...

编程新知 2026/1/30 17:10:19

Linux-07 ubuntu 的 chrome 启动不了

文章目录 问题原因解决步骤一、卸载旧版chrome二、重新安装chorme三、启动不了&#xff0c;报错如下四、启动不了&#xff0c;解决如下 总结 问题原因 在应用中可以看到chrome&#xff0c;但是打不开(说明&#xff1a;原来的ubuntu系统出问题了&#xff0c;这个是备用的硬盘&a…...

编程新知 2026/1/29 17:56:19