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

相关推荐
2501_9160074715 小时前
Windows OpenSSL 生成 iOS 证书,制作 p12 与描述文件,KXBuild 签名实操
windows·vscode·ios·objective-c·个人开发·swift·敏捷流程
我要见SA姐117 小时前
Chrome 内存泄漏诊断指南:从现象定位到根因排查
ide·vscode·python·自动化·编辑器
00后程序员张18 小时前
Windows 开发 iOS App 入门,用 SwiftUI 写第一个 iOS App 装到 iPhone
ide·vscode·ios·objective-c·个人开发·swift·敏捷流程
瓶 盖18 小时前
你的 IDE 插件改了 authorized_keys:Claude Code 扩展投毒链路拆解
ide·ssh·vs code·安全分析·供应链安全·claude code
香芋芋圆1 天前
iD-editor 详解|OSM官方在线编辑器,基于D3.js的轻量地图编辑器
开发语言·javascript·编辑器
qinglongcn2 天前
Agent 可能出什么事——五类异常与应对
人工智能·编辑器·ai编程
QianhangQianping2 天前
撤销重做不是「存快照」:一个可视化编辑器的Operation 设计
java·前端·数据库·typescript·编辑器·前端架构·撤销重做
Eiceblue2 天前
用 Python 给 Word 文档加水印:文字、图片与批量处理
开发语言·vscode·python·word
2501_915921432 天前
KXBuild CI 实操,Windows/Linux 服务器接入 Jenkins 打包 iOS IPA
服务器·windows·vscode·ios·ci/cd·个人开发·敏捷流程
Lhan.zzZ2 天前
用 Qt 构建线程安全的通讯静态库:从线程亲和性到完整工程
c++·vscode·qt·tcp/ip·udp