VScode 使用之自动生成文件注释

安装插件

下载安装Doxygen Documentation Generator插件

设置模板格式

设置方法一：配置文件

打开工程文件目录.vscode下的settings.json，设置模板格式，如下为个人使用的模板，相对比较简单，可以参考一下。

    "doxdocgen.file.copyrightTag": [
        "@copyright Copyright (c) {year}  公司名称"
    ],
   
    "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.authorName": "作者名称",
    "doxdocgen.generic.authorTag": "@author {author}",
 
    "doxdocgen.generic.order": [
        "brief",
        "tparam",
        "param",
        "return"
    ],
    "doxdocgen.generic.paramTemplate": "@param{indent:8}{param}{indent:25}My Param doc",
    "doxdocgen.generic.returnTemplate": "@return {type} ",
    "doxdocgen.generic.splitCasingSmartText": true,

输入/**然后回车查看效果
文件头部注释效果

/**
 * @file xxx.h
 * @brief 
 * @author 作者
 * @version 1.0
 * @date 2022-10-19
 * 
 * @copyright Copyright (c) 2022  公司名称
 * 
 */

函数注释效果

/**
 * @brief 
 * @param data 
 * @param len
 * @return 
 */
int fun(uint8_t *data, int len)
{
	
}

设置方法二：通过界面设置

文件>首选项>设置，搜索doxygen进行相关设置

其他配置模板

{
    // Doxygen documentation generator set
    // 文件注释：版权信息模板
    "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",		// @file
        "brief",	// @brief 简介
        "author",	// 作者
        "version",	// 版本
        "date",		// 日期
        "empty",	// 空行
        "copyright",// 版权
        "empty",
        "custom"	// 自定义
    ],
    // 下面时设置上面标签tag的具体信息
    "doxdocgen.file.fileTemplate": "@file {name}",
    "doxdocgen.file.versionTag": "@version 1.0",
    "doxdocgen.generic.authorEmail": "wanghuan3037@fiberhome.com",
    "doxdocgen.generic.authorName": "wangh",
    "doxdocgen.generic.authorTag": "@author {author} ({email})",
    // 日期格式与模板
    "doxdocgen.generic.dateFormat": "YYYY-MM-DD",
    "doxdocgen.generic.dateTemplate": "@date {date}",
	
    // 根据自动生成的注释模板（目前主要体现在函数注释上）
    "doxdocgen.generic.order": [
        "brief",
        "tparam",
        "param",
        "return"
    ],
    "doxdocgen.generic.paramTemplate": "@param{indent:8}{param}{indent:25}My Param doc",
    "doxdocgen.generic.returnTemplate": "@return {type} ",
    "doxdocgen.generic.splitCasingSmartText": true,
}

参考

如果需要详细了解Doxygen的设置可以参考下面这篇文章
代码注释规范之Doxygen