Vscode自定义注释模板

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

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

javascript 复制代码
"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上的西红柿助手 主题颜色。个人感觉还是挺好看的

相关推荐
Star(up up up)9 小时前
MySQL 事务隔离级别是如何实现的?从 MVCC 到锁机制原理详解
笔记·vscode·sql·学习·程序人生·mysql·学习方法
ScilogyHunter1 天前
[14] TMS570LC4357_VIM向量中断:128 通道、双 VIM 与硬件向量分发
单片机·编辑器·vim·excel·hercules·tms570
宝桥南山2 天前
Visual Studio 2026新特性 - 可以直接连接DeepSeek(使用Custom Endpoint Provider配置项)
ide·microsoft·微软·aigc·.net·visual studio
wangqiaowq2 天前
Protégé 开源本体(Ontology)编辑器
编辑器
张紫娃4 天前
idea 如何看一个类的 .class 文件
java·ide·intellij-idea
NoteDeep 深度笔记4 天前
DOM 被改乱了怎么办?Notedeep 编辑器的 normalize 设计
前端·javascript·编辑器
顧棟4 天前
组件生命周期设计:从硬编码初始化到状态机
java·ide
jianqiang.xue5 天前
Espressif-IDE进入维护模式:乐鑫把ESP32开发的宝押给VS Code
前端·css·ide