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

PyCharm添加自动函数文档注释

news 2025/7/7 23:41:19

目录

    • 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

数据库分批入库

今天在工作中&#xff0c;遇到一个问题&#xff0c;就是分批查询的时候&#xff0c;由于批次过大导致出现了一些问题&#xff0c;一下是问题描述和解决方案&#xff1a; 示例&#xff1a; // 假设已有数据列表 dataList 和 PreparedStatement pstmt int batchSize 1000; // …...

编程新知 2025/7/7 14:25:55

pikachu靶场通关笔记22-1 SQL注入05-1-insert注入(报错法)

目录 一、SQL注入 二、insert注入 三、报错型注入 四、updatexml函数 五、源码审计 六、insert渗透实战 1、渗透准备 2、获取数据库名database 3、获取表名table 4、获取列名column 5、获取字段 本系列为通过《pikachu靶场通关笔记》的SQL注入关卡(共10关&#xff0…...

编程新知 2025/7/7 14:33:26

代码随想录刷题day30

1、零钱兑换II 给你一个整数数组 coins 表示不同面额的硬币&#xff0c;另给一个整数 amount 表示总金额。 请你计算并返回可以凑成总金额的硬币组合数。如果任何硬币组合都无法凑出总金额&#xff0c;返回 0 。 假设每一种面额的硬币有无限个。 题目数据保证结果符合 32 位带…...

编程新知 2025/6/17 2:19:51

【Linux】Linux 系统默认的目录及作用说明

博主介绍&#xff1a;✌全网粉丝23W&#xff0c;CSDN博客专家、Java领域优质创作者&#xff0c;掘金/华为云/阿里云/InfoQ等平台优质作者、专注于Java技术领域✌ 技术范围&#xff1a;SpringBoot、SpringCloud、Vue、SSM、HTML、Nodejs、Python、MySQL、PostgreSQL、大数据、物…...

编程新知 2025/7/7 23:02:01

WPF八大法则：告别模态窗口卡顿

⚙️ 核心问题&#xff1a;阻塞式模态窗口的缺陷 原始代码中ShowDialog()会阻塞UI线程&#xff0c;导致后续逻辑无法执行&#xff1a; var result modalWindow.ShowDialog(); // 线程阻塞 ProcessResult(result); // 必须等待窗口关闭根本问题&#xff1a…...

编程新知 2025/7/6 22:58:45

tauri项目，如何在rust端读取电脑环境变量

如果想在前端通过调用来获取环境变量的值&#xff0c;可以通过标准的依赖&#xff1a; std::env::var(name).ok() 想在前端通过调用来获取&#xff0c;可以写一个command函数&#xff1a; #[tauri::command] pub fn get_env_var(name: String) -> Result<String, Stri…...

编程新知 2025/7/6 21:58:34

Python 训练营打卡 Day 47

注意力热力图可视化 在day 46代码的基础上&#xff0c;对比不同卷积层热力图可视化的结果 import torch import torch.nn as nn import torch.optim as optim from torchvision import datasets, transforms from torch.utils.data import DataLoader import matplotlib.pypl…...

编程新知 2025/7/6 11:33:09

Unity中的transform.up

2025年6月8日&#xff0c;周日下午 在Unity中&#xff0c;transform.up是Transform组件的一个属性&#xff0c;表示游戏对象在世界空间中的“上”方向&#xff08;Y轴正方向&#xff09;&#xff0c;且会随对象旋转动态变化。以下是关键点解析&#xff1a; 基本定义 transfor…...

编程新知 2025/7/7 17:10:03

Python训练营-Day26-函数专题1：函数定义与参数

题目1&#xff1a;计算圆的面积 任务&#xff1a; 编写一个名为 calculate_circle_area 的函数&#xff0c;该函数接收圆的半径 radius 作为参数&#xff0c;并返回圆的面积。圆的面积 π * radius (可以使用 math.pi 作为 π 的值)要求&#xff1a;函数接收一个位置参数 radi…...

编程新知 2025/7/7 14:02:19

Matlab实现任意伪彩色图像可视化显示

Matlab实现任意伪彩色图像可视化显示 1、灰度原始图像2、RGB彩色原始图像 在科研研究中&#xff0c;如何展示好看的实验结果图像非常重要&#xff01;&#xff01;&#xff01; 1、灰度原始图像 灰度图像每个像素点只有一个数值&#xff0c;代表该点的​​亮度&#xff08;或…...

编程新知 2025/7/7 10:24:50