Vscode自定义注释模板的实现示例

 更新时间:2023年07月19日 09:49:55   作者:不要影响我叠Q  
本文主要介绍了Vscode自定义注释模板的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

首先安装插件Doxygen Documentation Generator,安装完成之后点击Doxygen插件的设置,按照下面的步骤打开settings.json进行编辑:

在settings.json中追加如下代码:

"doxdocgen.file.copyrightTag": [
        "Copyright (C), 2023,"
    ],
    "doxdocgen.file.fileTemplate": "@file \t 【文件名称,不包含绝对路径】",
    "doxdocgen.generic.authorTag": "@author \t 【作者】",
    "doxdocgen.generic.dateTemplate": "@date \t {date}",
    "doxdocgen.generic.briefTemplate": "@brief \t 【简介】",
    "doxdocgen.generic.returnTemplate": "@return \t 【解释返回值】 ",
    "doxdocgen.file.customTag": [ //文件级的自定义注释
        "@note \t 【重大修改可以放在这里】",
    ],
    "doxdocgen.generic.customTags": [
        "@warning\t 【不可重入、阻塞等属性特殊说明】",
        "@note\t 【重大修改】",
    ],
    "doxdocgen.generic.paramTemplate": "@param \t {param} [in/out], 参数意义",
    "doxdocgen.file.fileOrder": [
        "copyright",
        "", //这个地方表示换行
        "file",
        "author",
        "date",
        "brief",
        "custom",
    ],
    "doxdocgen.generic.order": [
        "brief",
        "param",
        "return",
        "custom"
    ]

切回vscode,在函数上方输入/***/,然后再第二个*后面按一下enter键,自定义注释模板即可生效,如下图:

多插一句嘴,我的主题插件是Visual Assist Dark Theme插件,改编自visual studio上的西红柿助手 主题颜色。个人感觉还是挺好看的

到此这篇关于Vscode自定义注释模板的实现示例的文章就介绍到这了,更多相关Vscode自定义注释模板内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • C语言中动态内存分配malloc、calloc和realloc函数解析

    C语言中动态内存分配malloc、calloc和realloc函数解析

    C语言跟内存申请相关的函数主要有 alloca、calloc、malloc、free、realloc等,下面这篇文章主要给大家介绍了关于C语言中动态内存分配malloc、calloc和realloc函数的相关资料,需要的朋友可以参考下
    2022-03-03
  • C++ 详细讲解stack与queue的模拟实现

    C++ 详细讲解stack与queue的模拟实现

    C++ Stack(堆栈) 是一个容器类的改编,为程序员提供了堆栈的全部功能,也就是说实现了一个先进后出(FILO)的数据结构,许多程序都使用了 queue 容器。queue 容器可以用来表示超市的结账队列或服务器上等待执行的数据库事务队列
    2022-04-04
  • C++深入探究用NULL来初始化空指针是否合适

    C++深入探究用NULL来初始化空指针是否合适

    在C++11新特性中,我们用nullptr来表示指针空值,这是为什么呢?好好地NULL为什么不继续使用呢?说明在创造C++的大佬们一定发现了什么Bug,本篇我们就一起来讨论一下吧
    2022-05-05
  • C++编程中的数据类型和常量学习教程

    C++编程中的数据类型和常量学习教程

    这篇文章主要介绍了C++编程中的数据类型和常量学习教程,是C++入门学习中的基础知识,需要的朋友可以参考下
    2015-09-09
  • C++实现读写文件的示例代码

    C++实现读写文件的示例代码

    这篇文章主要介绍了C++实现读写文件的示例代码,帮助大家更好的理解和学习c++,感兴趣的朋友可以了解下
    2020-08-08
  • C语言中的strlen()和sizeof()对比分析

    C语言中的strlen()和sizeof()对比分析

    这篇文章主要介绍了C语言中的strlen()和sizeof()区别对比,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-03-03
  • 探讨register关键字在c语言和c++中的差异

    探讨register关键字在c语言和c++中的差异

    建议不要用register关键字定义全局变量,因为全局变量的生命周期是从执行程序开始,一直到程序结束才会终止,而register变量可能会存放在cpu的寄存器中,如果在程序的整个生命周期内都占用着寄存器的话,这是个相当不好的举措
    2013-10-10
  • C语言封装函数字符串练习汇总分享

    C语言封装函数字符串练习汇总分享

    这篇文章主要介绍了C语言封装函数字符串练习汇总分享,分享内容有字符串查找、字符串拼接、字符串转整数等内容,需要而小伙伴可以参考一下
    2022-03-03
  • C++ STL关联式容器自定义排序规则的2种方法

    C++ STL关联式容器自定义排序规则的2种方法

    这篇文章主要介绍了C++ STL关联式容器自定义排序规则的2种方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-03-03
  • C++回溯算法中子集问题分析探讨

    C++回溯算法中子集问题分析探讨

    回溯法是一种选优搜索法,按选优条件向前搜索,以达到目标。但当探索到某一步时,发现原先选择并不优或达不到目标,就退回一步重新选择,这种走不通就退回再走的技术为回溯法,而满足回溯条件的某个状态的点称为回溯点
    2023-03-03

最新评论