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

PyCharm添加自动函数文档注释

news 2026/3/27 4:31:27

目录

    • 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

OpenClaw环境迁移：GLM-4.7-Flash配置的备份与恢复方案

OpenClaw环境迁移&#xff1a;GLM-4.7-Flash配置的备份与恢复方案 1. 为什么需要环境迁移&#xff1f; 上周我的主力开发机突然硬盘故障&#xff0c;导致所有OpenClaw配置丢失。最痛心的是花了两周调试的GLM-4.7-Flash对接设置全部归零——包括精心调整的温度参数、自定义提示…...

编程新知 2026/3/27 3:39:25

ESP32-S3 OV2640摄像头从AP模式到STA模式的保姆级切换教程（附完整代码）

ESP32-S3 OV2640摄像头从AP模式到STA模式的保姆级切换教程&#xff08;附完整代码&#xff09; 当你第一次拿到ESP32-S3开发板和OV2640摄像头模块时&#xff0c;可能会被官方例程中的AP&#xff08;热点&#xff09;模式所困扰。虽然AP模式让设备快速上线&#xff0c;但在实际家…...

编程新知 2026/3/27 3:27:07

从巨鲸到万物生长：Claude Code如何颠覆AI开发，带你从对话走向Agent平台搭建！

Claude Code凭借其六大核心能力&#xff0c;将AI开发带入全新阶段。通过CLAUDE.md实现项目记忆增强&#xff0c;Skills固化可复用工作流&#xff0c;Sub-Agent处理专业化任务&#xff0c;MCP连接外部服务&#xff0c;Plug-In打包完整解决方案。本文深入解析这些功能&#xff0c…...

编程新知 2026/3/27 2:34:45

CDN图片服务与动态参数优化

前言在现代Web应用中&#xff0c;图片已经不再是简单的静态资源&#xff0c;而是需要根据设备、网络、浏览器能力动态优化的核心内容。CDN图片服务提供了强大的动态处理能力&#xff0c;结合前端的智能参数拼接&#xff0c;可以实现图片加载的极致优化。一个典型的电商场景&…...

编程新知 2026/3/27 2:00:39

[特殊字符] 怕你停电的姐姐：UPS 还分 “直流” 和 “交流”？ 今天一篇给你盘个透！

哈喽&#xff0c;我的老铁们&#xff01;我是你们那个 “怕你停电” 的姐姐&#xff0c;也是专门卖 UPS 电源的姐姐&#xff01;平时总有朋友问我&#xff1a;“姐姐&#xff0c;我看 UPS 有好多种&#xff0c;什么直流交流的&#xff0c;到底有啥区别&#xff1f;我该咋选&…...

编程新知 2026/3/27 1:44:29

OpenClaw安全指南：使用GLM-4.7-Flash时的权限管理

OpenClaw安全指南&#xff1a;使用GLM-4.7-Flash时的权限管理 1. 为什么需要特别关注OpenClaw的安全配置 当我第一次在本地部署OpenClaw并接入GLM-4.7-Flash模型时&#xff0c;最让我震惊的是这个框架赋予AI的权限范围。它不仅能读取我的文件&#xff0c;还能执行系统命令、发…...

编程新知 2026/3/27 1:30:21

Teensy41嵌入式FTP服务器库：轻量协议栈与多网络适配

1. 项目概述FTP_Server_Teensy41 是一款专为 Teensy 4.x 系列微控制器&#xff08;特别是 Teensy 4.0 和 Teensy 4.1&#xff09;深度定制的嵌入式 FTP 服务器库。它并非从零构建&#xff0c;而是基于 Jean-Michel Gallego 开发的成熟开源项目 Arduino-Ftp-Server 进行了系统性…...

编程新知 2026/3/27 1:24:20

Go Mutex 与 RWMutex 性能对比

在Go语言并发编程中&#xff0c;Mutex&#xff08;互斥锁&#xff09;和RWMutex&#xff08;读写锁&#xff09;是两种常用的同步机制。它们的性能差异直接影响高并发场景下的程序效率。本文将从多个角度对比两者的性能表现&#xff0c;帮助开发者根据实际需求选择合适的锁机制…...

编程新知 2026/3/27 1:07:41

ROS Noetic + RealSense D435i：从驱动安装到RVIZ点云显示的完整工作流解析

ROS Noetic RealSense D435i&#xff1a;从驱动安装到RVIZ点云显示的完整工作流解析 在机器人视觉项目的初期搭建阶段&#xff0c;开发者往往面临一个关键挑战&#xff1a;如何将深度相机从"硬件连接"快速推进到"可用数据流"状态。以Intel RealSense D435…...

编程新知 2026/3/27 0:53:39

全球碳块市场调查：年复合增长率（CAGR）稳定保持在3.4%（2026 - 2032）

市场规模&#xff1a;稳健增长&#xff0c;潜力巨大QYResearch调研数据显示&#xff0c;2025年全球碳块市场规模预计约为17.75亿美元&#xff0c;而到2032年&#xff0c;这一数字将跃升至22.36亿美元。在2026 - 2032年期间&#xff0c;年复合增长率&#xff08;CAGR&#xff09…...

编程新知 2026/3/27 0:23:27