vscode自动添加注释说明

这篇具有很好参考价值的文章主要介绍了vscode自动添加注释说明。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

1. 安装vscode


双击安装程序,默认安装即可(如:VSCodeSetup-x64-1.70.2.exe)

2. 安装doxygen文档生成插件


1> 打开vscode软件,点击左侧插件管理菜单
2> 点击右上角’…‘按钮,选择’Install from VSIX’(联网状态可以直接搜索doxygen下载安装)
3> 选择doxygen离线安装包,如cschlosser.doxdocgen-1.4.0.vsix
vscode自动添加注释说明,c++技术,vscode,ide,编辑器,自动注释,补全

3. 修改doxygen默认配置


1> 按’ctrl + shift + p’打开配置项目,选择’Preferences:Open User Settings(JSON)’
vscode自动添加注释说明,c++技术,vscode,ide,编辑器,自动注释,补全
2> 黏贴以下配置内容到配置文件中,注意修改authorName等名字信息,可以全局替换一下

{
    /*GXT-Doxygen Documentation Generator插件使用-Begin*/
    // 作者名和邮箱
    "doxdocgen.generic.authorName": "yangchao",
    "doxdocgen.generic.authorEmail": "yangchao@163.com",
    "doxdocgen.generic.authorTag": "@Author : {author} email:{email}",
    // 日期格式
    "doxdocgen.generic.dateFormat": "YYYY-MM-DD",
    "doxdocgen.generic.dateTemplate": "@Creat Date : {date}",
    // 简介格式
    "doxdocgen.generic.briefTemplate": "@brief{indent:8}{text}",
    // 文件注释的格式
    "doxdocgen.file.fileTemplate": "@File Name: {name}",
    "doxdocgen.file.versionTag": "@Version : 1.0",
    "doxdocgen.file.copyrightTag": [
        "@copyright Copyright (c) {year} Co., Ltd. All rights reserved."
    ],
    // 自定义文件注释格式
    "doxdocgen.file.customTag": [
        "modification history :",
        "Date:       Version:      Author:     ",
        "Changes: ",
    ],
    // 文件注释组成及顺序
    "doxdocgen.file.fileOrder": [
        "file",    // @file
        "brief",    // @brief 简介
        "author",    // 作者
        "version",    // 版本
        "date",    // 日期
        "empty",    // 空行
        "copyright",// 版权
        // "custom"    // 自定义
    ],
    // 参数注释和返回注释的格式
    "doxdocgen.generic.paramTemplate": "@param{indent:8}{param}: ",
    "doxdocgen.generic.returnTemplate": "@return{indent:8}{type}: ",
    // 函数注释组成及顺序
    "doxdocgen.generic.order": [
        "brief",
        "tparam",
        "param",
        "return"
    ],
    "editor.fontFamily": "Courier New",
    "window.zoomLevel": 1,
    /*GXT-Doxygen Documentation Generator插件使用-End*/
}

3> 配置完成后即可使用,在文件头或者函数前都可以输入’/**'然后按回车即可生成固定格式的注释文章来源地址https://www.toymoban.com/news/detail-633030.html

到了这里,关于vscode自动添加注释说明的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 【vscode】生成函数参数@param注释 及 自动添加头注释和函数注释

    自动添加头部、函数注释 方法一:输入/**,IDE会自动弹出完整的多行注释demo: 方法二:下载安装koroFileHeader, 一个vscode插件, 用于生成文件头部注释和函数注释的插件,效果如下: 用户设置文件settings.json,输入以下配置: 配置完成保存后, 重启vscode 完成插件环境生成。

    2024年02月13日
    浏览(56)
  • Unity 编辑器-创建模板脚本,并自动绑定属性,添加点击事件

    当使用框架开发时,Prefab挂载的很多脚本都有固定的格式。从Unity的基础模板创建cs文件,再修改到应有的模板,会浪费一些时间。尤其是有大量的不同界面时,每个都改一遍,浪费时间不说,还有可能遗漏或错改。写个脚本创建指定的模板代替C#基础模板。 注:当前脚本使用

    2024年02月13日
    浏览(60)
  • 在VScode中,文件自动添加头部注释-插件koroFileHeader配置

    korofileheader插件是用于一键生成文件头部注释并自动更新最后编辑人和编辑时间、函数注释自动生成和参数提取。 首先打开VScode,进入扩展商店,搜索 koroFileHeader 进行安装 打开设置-搜索 Fileheader -点击头部注释的 setting.json 文件 可以在其中配置头部注释 其中作者和邮箱可以

    2024年02月15日
    浏览(55)
  • vscode编辑器,vue、小程序等语言适配eslint格式校验 + prettier 保存时自动修改格式

    目的:自留备份,用者自取 基础配置 1 基于vscode编辑器,prettier插件需要下载 2 eslint配置项规则: https://eslint.bootcss.com/docs/rules/ 3 prettier配置项规则: https://prettier.io/docs/en/options.html 安装插件 配置文件问题: 如果项目中带有.vscode文件夹,这里面的setting.json会覆盖全局的sett

    2024年02月09日
    浏览(55)
  • Vim 编辑器|批量注释与批量取消注释

    添加注释 ctrl + v 进入块选泽模式。 上下键选中需要注释的行。 按大写 I ( shift + i ) 进入插入模式,输入注释符。 按两次 ESC 退出,即完成添加注释。 shift + : 再输入 qw   保存退出。 取消注释 ctrl + v 进入块选泽模式。 上下键选中需要注释的行。 按小写 x 删除注释符。 按

    2024年03月14日
    浏览(79)
  • 2023最佳python编辑器和IDE

    IDE没有统一的标准,自己习惯就是最好的。本文列出一些较常用的IDE,供大家参考。 一般而言,WingIDE、PyCharm、Spyder、Vim是比较常用的IDE。 Spyder是Python(x,y)的作者为它开发的一个简单的集成开发环境。和其他的Python开发环境相比,它最大的优点就是模仿MATLAB的\\\"工作空间\\\"的功

    2024年02月05日
    浏览(53)
  • 11 个最佳 C++ IDE(和代码编辑器)

    C++ 是一种功能强大、用途广泛的编程语言。它也可以是一个艰难的大师。 这意味着在您的工具带中拥有正确的工具以帮助您更高效、更有效、更自信地编写代码至关重要。 在为 C++ 编程寻找最佳 IDE 或代码编辑器时,您应该从哪里开始?IDE 选项列表几乎是无限的,很难判断

    2024年02月04日
    浏览(57)
  • IntelliJ IDE 插件开发 | (五)VFS 与编辑器

    IntelliJ IDE 插件开发 |(一)快速入门 IntelliJ IDE 插件开发 |(二)UI 界面与数据持久化 IntelliJ IDE 插件开发 |(三)消息通知与事件监听 IntelliJ IDE 插件开发 |(四)来查收你的 IDEA 使用报告吧 IntelliJ IDE 插件开发 |(五)VFS 与编辑器 在前几篇文章中主要介绍了关于 IntelliJ IDE 插

    2024年01月25日
    浏览(53)
  • IDE /Qt Creator 文本编辑器之文件编码设置

    在 Qt Creator 工具 - 选项 - 文本编辑器 - 行为选项卡中,存在一个叫作 “文件编码” 的配置项。其默认配置如下, 我是栽了不少坑之后,才理解到它的用途和作用方式的。这是一个有用的配置项,尤其是在使用 Qt Creator + MSVC 组成的集成开发环境时。我是在整理 《IDE/warning:

    2024年02月13日
    浏览(55)
  • 轻量级 IDE & 文本编辑器 Geany 发布 2.0

    导读 Geany 是功能强大、稳定、轻量的开发者专用文本编辑器,支持 Linux、Windows 和 macOS,内置支持 50 多种编程语言。 2005 年Geany 发布首个版本 0.1。上周四刚好是 Geany 诞生 18 周年纪念日,官方发布了 2.0 正式版以表庆祝。 下载地址:https://www.geany.org/download/releases/ Geany 2.0 主

    2024年02月07日
    浏览(40)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包