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++ 实现的通讯录管理系统详解

    C++ 实现的通讯录管理系统详解

    这篇文章主要为大家详细介绍了C++实现通讯录管理系统,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-10-10
  • C++中vector可以作为map的键值实例代码

    C++中vector可以作为map的键值实例代码

    这篇文章主要介绍了C++中vector可以作为map的键值实例代码,需要的朋友可以参考下
    2017-07-07
  • C语言中二级指针的实例详解

    C语言中二级指针的实例详解

    这篇文章主要介绍了C语言中二级指针的实例详解的相关资料,希望通过本文能帮助到大家,让大家掌握理解二级指针的知识,需要的朋友可以参考下
    2017-10-10
  • C++详解哈夫曼树的概念与实现步骤

    C++详解哈夫曼树的概念与实现步骤

    给定N个权值作为N个叶子结点,构造一棵二叉树,若该树的带权路径长度达到最小,称这样的二叉树为最优二叉树,也称为哈夫曼树(Huffman Tree)。哈夫曼树是带权路径长度最短的树,权值较大的结点离根较近
    2022-04-04
  • C++中jsoncpp库和nlohmann-json库实现JSON与字符串类型转换

    C++中jsoncpp库和nlohmann-json库实现JSON与字符串类型转换

    jsoncpp是ROS自带的一个JSON库,它提供了一些函数来解析和生成JSON数据,在ROS中,可以使用jsoncpp库来实现JSON与字符串类型之间的转换,这篇文章主要介绍了jsoncpp库和nlohmann-json库实现JSON与字符串类型转换,需要的朋友可以参考下
    2023-08-08
  • 实战开发为单片机的按键加一个锁防止多次触发的细节

    实战开发为单片机的按键加一个锁防止多次触发的细节

    今天小编就为大家分享一篇关于实战开发为单片机的按键加一个锁防止多次触发的细节,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2018-12-12
  • C语言rewind与fseek函数之随机读写文件的用法详解

    C语言rewind与fseek函数之随机读写文件的用法详解

    这篇文章主要介绍了C语言rewind与fseek函数之随机读写文件的用法详解,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下
    2021-09-09
  • C语言实现动态版通讯录的示例代码

    C语言实现动态版通讯录的示例代码

    这篇文章主要为大家详细介绍了如何利用C语言实现一个简单的动态版通讯录,文中的示例代码讲解详细,对我们学习C语言有一定帮助,需要的可以参考一下
    2022-08-08
  • C++中类的默认成员函数详解

    C++中类的默认成员函数详解

    大家好,本篇文章主要讲的是C++中类的默认成员函数详解,感兴趣的同学赶快来看一看吧,对你有帮助的话记得收藏一下
    2022-01-01
  • Qt 使用Poppler实现pdf阅读器的示例代码

    Qt 使用Poppler实现pdf阅读器的示例代码

    下面小编就为大家分享一篇Qt 使用Poppler实现pdf阅读器的示例代码,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-01-01

最新评论