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自定义注释模板内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Matlab实现鼠标光标变成爱心和瞄准镜形状
这篇文章主要为大家详细介绍了如何利用Matlab实现将鼠标光标变成爱心和瞄准镜等形状，文中的示例代码讲解详细，感兴趣的可以了解一下
2022-08-08
C++实现LeetCode(172.求阶乘末尾零的个数)
这篇文章主要介绍了C++实现LeetCode(172.求阶乘末尾零的个数),本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下
2021-08-08
C语言实现手机电话簿管理系统
这篇文章主要为大家详细介绍了C语言实现手机电话簿管理系统，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-06-06
C语言智能指针 shared_ptr 和 weak_ptr
这篇文章主要介绍了C语言智能指针 shared_ptr 和 weak_ptr，weak_ptr引入可以解决shared_ptr交叉引用时无法释放资源的问题，下面来学习具体相关内容吧,需要的朋友可以参考一下
2022-04-04
C语言举例讲解转义字符的使用
转义字符是很多程序语言、数据格式和通信协议的形式文法的一部分。对于一个给定的字母表，一个转义字符的目的是开始一个字符序列，使得转义字符开头的该字符序列具有不同于该字符序列单独出现（没有转义字符开头）时的语义。因此转义字符开头的字符序列被叫做转义序列
2022-05-05
C/C++中获取重载函数地址的方法
函数重载是函数的一种特殊情况,C++允许在同一作用域中声明几个功能类似的同名函数,这些同名函数的形参列表不同,常用来处理实现功能类似数据类型不同的问题,本文给大家介绍了C/C++中获取重载函数地址的方法,需要的朋友可以参考下
2024-04-04
C语言实现选择排序、直接插入排序、冒泡排序的示例
这篇文章主要介绍了C++实现选择排序、直接插入排序、冒泡排序的代码示例,相当简洁直观,也是算法和数据结构学习中的基础,需要的朋友可以参考下
2016-02-02
C++中的异或运算符^的使用方法
本篇文章对C++中的异或运算符^的使用方法进行的详细的分析介绍，需要的朋友参考下
2013-05-05
解析在Direct2D中画Bezier曲线的实现方法
本篇文章是对在Direct2D中画Bezier曲线的实现方法进行了详细的分析介绍，需要的朋友参考下
2013-05-05
Qt键盘事件实现图片在窗口上下左右移动
这篇文章主要为大家详细介绍了Qt键盘事件实现图片在窗口上下左右移动，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-08-08

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

相关文章

最新评论

大家感兴趣的内容

最近更新的内容

常用在线小工具