Vscode Doxygen 注释配置

下载Doxygen Documentation Generator 插件

进入设置界面编辑

在settings.json中添加

{

    // Doxygen documentation generator set

    "doxdocgen.c.triggerSequence": "/*",

    "doxdocgen.c.firstLine": "/******************************************************************************",

    "doxdocgen.c.commentPrefix": "*   ",

    "doxdocgen.c.lastLine": "******************************************************************************/",

    "doxdocgen.generic.linesToGet": 150, //如果有很多超级大函数要把这个值设置很大

    // 文件注释：版权信息模板

    "doxdocgen.file.copyrightTag": [

        "@copyright (C) {year} xxxxxxxx"

    ],

    // 文件注释：自定义模块，这里我添加一个修改日志

    "doxdocgen.file.customTag": [

        "@par        changelist:",

       

        "Date        Version  Author         Description",

        "{date}  1.0      {author}       first edition",  

       

    ],

    // 文件注释的组成及其排序

    "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": "xx@fiberhome.com",

    "doxdocgen.generic.authorName":"xx",

    "doxdocgen.generic.authorTag": "@author    {author} ",

    // 日期格式与模板

    "doxdocgen.generic.dateFormat":       "YYYY-MM-DD",

    "doxdocgen.generic.dateTemplate": "@date      {date}",

    "doxdocgen.generic.briefTemplate": "@brief     {text}",

   

    // 根据自动生成的注释模板（目前主要体现在函数注释上）

    "doxdocgen.generic.order": [

        "brief",

        "author",

        "date",

        "tparam",

        "param",

        "return"

    ],

    "doxdocgen.generic.paramTemplate": "@param{indent:8}   {param}{indent:25}My Param doc",

    "doxdocgen.generic.returnTemplate": "@return    {type}  return doc",

    "doxdocgen.generic.splitCasingSmartText": true,

   

}

添加注释的方法为在函数头输入/*+回车，或者文件头/*+回车