vscode自动生成docgen注释

最新推荐文章于 2025-05-09 16:12:38 发布

原创

最新推荐文章于 2025-05-09 16:12:38 发布 · 1.5k 阅读

6 ·

CC 4.0 BY-SA版权

文章标签：

#linux #windows #c++

本文介绍如何利用VSCode插件Doxdocgen为代码自动生成规范化的文档注释，包括安装步骤、配置方法及测试过程。

1）选择安装扩展：左下角齿轮，扩展，搜索“doxdocgen”，

2）安装后，左侧插件上点邮件，菜单中选“扩展设置”，右侧见到设置页面，就是可以配置各个部分的参数。可以直接点击“在setting.json编辑”，直接打开setting.json文件，根对象下（一级花括号）添加相关属性如下

"doxdocgen.file.copyrightTag": [
        "@copyright Copyright (c) {year}  XX通信公司"
    ],
    "doxdocgen.file.customTag": [
        "@par 修改日志:",
        "<table>",
        "<tr><th>Date       <th>Version <th>Author  <th>Description",
        "<tr><td>{date} <td>1.0     <td>wangh     <td>内容",
        "</table>",
    ],
    "doxdocgen.file.fileOrder": [
        "file",
        "brief",
        "author",
        "version",
        "date",
        "empty",
        "copyright",
        "empty",
        "custom"
    ],
    "doxdocgen.file.fileTemplate": "@file {name}",
    "doxdocgen.file.versionTag": "@version 1.0",
    "doxdocgen.generic.authorEmail": "wanghuan3037@fiberhome.com",
    "doxdocgen.generic.authorName": "wang