vscode自动添加文件和函数注释

news2024/11/25 11:26:41

自动添加注释

  • Doxygen Documentation Generator
  • 配置
    • 配置选项介绍
    • 配置文件头注释
    • 配置函数头注释

Doxygen Documentation Generator

此插件是vscode自动注释添加的插件,首先需要在vscode中查找并安装插件。如下图所示,插件在未安装的情况下会显示蓝色的Install样式,直接点击即可自动安装,已安装的情况下会显示设置图标。
在这里插入图片描述

配置

根据下图标注进入配置页面。
在这里插入图片描述

配置选项介绍

C:Comment PreFix : 表示除了注释第一行和最后一行其他注释行的前缀
C:First Line:表示注释第一行显示的内容
C:Last Line:表示注释最后一行显示的内容
C:Trigger Sequence:设置触发注释的方式,类似于快捷键,输入字符序列然后回车即可自动填充注释信息
Cpp:Tparam Tempate:表示函数参数注释
File:Copyright Tag:表示填充的版权信息,需要在settings.json中进行配置
File:File Order :用于对文件头注释信息排序,即按照规定的顺序对各注释字段排序
File:File Template:文件名称注释,@file {name},表示会生成注释行@file name会被文件名称替换
File:Version Tag:文件版本信息注释,@version 0.1,则自动生成的文件头注释会有此信息行
Generic:Author Email:使用到邮箱信息时,会以此处的邮箱进行自动填充
Generic:Author Name:使用到用户名信息时,会以此处的信息进行自动填充
Generic:Author Tag:用户名注释行会以此处设置的格式进行填充
Generic:Brief Template:表示要填充的说明信息
Generic:Custom Tags:表示用户自定义信息,需要在settings.json中配置保存
Generic:Date Format:设置要显示的日期格式
Generic:Date Template:设置日期注释行,日期格式按上述设置的格式显示
Generic:Order:设置函数注释各字段的排列顺序
Generic: Param Template:设置函数参数注释行格式,可自动罗列函数参数信息
Generic: Return Template:设置函数返回值注释行的格式
在这里插入图片描述

配置文件头注释

自动生成文件头信息如下所示:
在这里插入图片描述

配置函数头注释

自动生成的函数头信息如下所示:
在这里插入图片描述

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/1024103.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

go-redis 框架基本使用

文章目录 redis使用场景下载框架和连接redis1. 安装go-redis2. 连接redis 字符串操作有序集合操作流水线事务1. 普通事务2. Watch redis使用场景 缓存系统,减轻主数据库(MySQL)的压力。计数场景,比如微博、抖音中的关注数和粉丝数…

【zotero】解决换新电脑后PDF打不开

关于zoteroPDF无法打开,并且提示:它可能已被移动或删除到 Zotero 之外,或者一台计算机上的链接附件基本目录可能设置不正确。 第一步:下载zutilo第二步:zutilo获取路径第三步 修改路径最后:新旧路径对比 第…

笔记1.6:计算机网络发展历史

1961-1972:早期分组交换原理的提出与应用 1972-1980:网络互连,大量新型、私有网络的涌现 1980-1990:新型网络协议与网络的激增 1999、2000‘s:商业化、Web、新应用 2005- ? :

ChatGPT AIGC 完成各省份销售动态可视化分析

像这样的动态可视化由人工智能ChatGPT AIGC结合前端可视化技术就可以实现。 Prompt:请使用HTML,JS,Echarts 做一个可视化分析的案例,地图可视化,数据可以随机生成,请写出完整的代码 完整代码复制如下: <!DOCTYPE html> <html> <head><meta char…

汽油辛烷值的测定 马达法

声明 本文是学习GB-T 503-2016 汽油辛烷值的测定 马达法. 而整理的学习笔记,分享出来希望更多人受益,如果存在侵权请及时联系我们 8 试剂和标准物 8.1 气缸夹套冷却液 若实验室所处海拔的水沸点为100℃1.5℃(212 F3F), 应使用水作为气缸夹套冷却液。当 实验室海拔高度不确定…

Android 滑动事件消费监控,Debug 环境下通用思路

Android Debug 环境下滑动事件消费监控通用思路 背景 Android 开发中&#xff0c;经常会遇到滑动事件冲突。在一些简单的场景下&#xff0c;我们如果能够知道是那个 View 拦截了事件&#xff0c;那我们能够很容易得解决。解决方法通常就是内部拦截法或者外部拦截法。ViewPage…

「深度学习之优化算法」(十九)蚁狮算法

1. 蚁狮算法简介 (以下描述,均不是学术用语,仅供大家快乐的阅读)    蚁狮是一种昆虫,城里长大的我没有见过这玩意儿,请教了农村长大小的伙伴,依然没见过,这玩意儿可能在我们生活的地方分布较少。 (图片及介绍来自百度百科)    蚁狮算法(Ant Lion Optimization…

自己动手写数据库:关系代数和查询树执行效率的推导

上几节我们完成了 sql 解释器的实现。通过解析 sql 语句&#xff0c;我们能知道 sql 语句想做什么&#xff0c;接下来就需要执行 sql 语句的意图&#xff0c;也就是从给定表中抽取所所需要的数据。要执行 sql 语句&#xff0c;我们需要了解所谓的“关系代数”&#xff0c;所谓代…

py基础语法

输出&#xff1a; print("wbshpnshp")输入&#xff1a; 1.raw_input() str raw_input("请输入&#xff1a;") print "你输入的内容是: ", str2.input(), input 可以接收一个Python表达式作为输入&#xff0c;并将运算结果返回。 str input(…

【C++面向对象侯捷】3.构造函数

文章目录 class 的声明inline&#xff08;内联&#xff09;函数access level&#xff08;访问级别&#xff09;构造函数构造函数可以有多个- 重载&#xff01; class 的声明 inline&#xff08;内联&#xff09;函数 access level&#xff08;访问级别&#xff09; 构造函数 构…

Flutter的基础知识、核心概念以及一些实际开发技巧

Flutter的基础知识、核心概念以及一些实际开发技巧 前言深入探讨Flutter应用程序开发一、什么是Flutter&#xff1f;Dart编程语言Widget组件模型 二、Flutter的核心概念MaterialApp和ScaffoldWidget生命周期布局和排列状态管理 三、实际开发技巧使用Hot Reload适应不同屏幕尺寸…

OpenHarmony AI框架开发指导

一、概述 1、功能简介 AI 业务子系统是 OpenHarmony 提供原生的分布式 AI 能力的子系统。AI 业务子系统提供了统一的 AI 引擎框架&#xff0c;实现算法能力快速插件化集成。 AI 引擎框架主要包含插件管理、模块管理和通信管理模块&#xff0c;完成对 AI 算法能力的生命周期管理…

用katalon解决接口/自动化测试拦路虎--参数化

不管是做接口测试还是做自动化测试&#xff0c;参数化肯定是一个绕不过去的坎。 因为我们要考虑到多个接口都使用相同参数的问题。所以&#xff0c;本文将讲述一下katalon是如何进行参数化的。 全局变量 右侧菜单栏中打开profile&#xff0c;点击default&#xff0c;打开之后…

微信小程序实现删除功能

1. 前端 项目列表展示是使用的wx&#xff1a;for遍历 每个项目展示有3个模块 1. project-title 2. project-content 3. project-foot 全部代码如下 <t-sticky><view class"search"><t-search model:value"{{conditions.keyword}}" pl…

adb shell命令查看当前屏幕可见最顶层Activity和Fragment及其调用栈

adb shell命令查看当前屏幕可见最顶层Activity和Fragment及其调用栈 &#xff08;1&#xff09;当前屏幕可见页面最顶层是哪个Activity: adb shell "dumpsys activity top | grep ACTIVITY | tail -n 1"&#xff08;2&#xff09;当前屏幕可见页面最顶层是哪个Fragm…

mac使用指南

新公司给配备了mac&#xff0c;可惜土鳖的我不会用&#xff0c;所以特地写了一篇文章记录学习mac的过程 快捷键 删除&#xff1a;commanddelete 光标移至最右/左&#xff1a;command右/左箭头 截图&#xff1a;commandshift3/4/5&#xff0c;3代表截全屏&#xff0c;4代表选…

PDF合并和拆分软件 PDF Merge PDF Splitter mac中文版v6.3.9

PDF Merge PDF Splitter mac是一款用于合并和拆分PDF文件的工具。它可以将多个PDF文件合并为一个&#xff0c;也可以将一个PDF文件拆分为多个文件。 合并PDF文件&#xff1a;用户可以将多个PDF文件合并为一个文件。合并后的PDF文件保留原有的文档结构和格式&#xff0c;包括书签…

Winform直接与Wpf交互

Winform项目中&#xff0c;可以直接使用wpf中的自定义控件和窗体 测试环境&#xff1a; vistual studio 2017 window 10 一 winform直接使用wpf的自定义控件 步骤如下&#xff1a; 1 新建winfrom项目&#xff0c;名为WinFormDemo&#xff0c;默认有一个名为Form1的窗体…

方案:基于AI烟火识别与视频技术的秸秆焚烧智能化监控预警方案

一、方案背景 为严控秸秆露天焚烧&#xff0c;改善环境空气质量&#xff0c;各省相继发布秸秆禁烧工作内容。以安徽省为例&#xff0c;大气污染防治联席会议下发了该省2020年秸秆禁烧工作部署通知。2020年起&#xff0c;气象局将对全省秸秆焚烧火点实施卫星全年全时段监测&…

Ruijie未授权访问

本文由掌控安全学院 - 杳若 投稿 漏洞成因 没进行权限校验。 影响范围 Ruijie 发现方式 一、fofa发现 1. title"Ruijie Easy-Smart Switch"利用方式 访问之后直接是进入后台的样子~ 实战 修复方式 对于鉴权类型的漏洞&#xff0c;主要的修复方式是全局增加…