VSCode用Doxygen自定义代码注释配置

66次阅读
没有评论

安装Doxygen插件

VSCode用Doxygen自定义代码注释配置

设置注释格式

组合键ctrl+shift+p打开命令,输入settings搜索,打开用户setting.json文件,如下图所示:

VSCode用Doxygen自定义代码注释配置

将下面的配置放入文件中保存即可

    // Doxygen documentation generator set
    // 文件注释:版权信息模板
    "doxdocgen.file.copyrightTag": [
        "@copyright Copyright (c) {year}  xxx技术股份有限公司"
    ],
    // 文件注释:自定义模块,这里我添加一个修改日志
    "doxdocgen.file.customTag": [
        "@par 修改日志:",
        "",
        "Date       Version Author   Description",
        "{date}     1.0     xxxxx    Created",
        "",
    ],
    // 文件注释的组成及其排序
    "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": "xxx@xlzyw.top",
    "doxdocgen.generic.authorName": "xxx",
    "doxdocgen.generic.authorTag": "@author {email}",
    // 日期格式与模板
    "doxdocgen.generic.dateFormat": "YYYY-MM-DD",
    "doxdocgen.generic.dateTemplate": "@date {date}",

    // 根据自动生成的注释模板(目前主要体现在函数注释上)
    "doxdocgen.generic.order": [
        "brief",
        "date",
        "author",
        "tparam",
        "param",
        "return"
    ],
    "doxdocgen.generic.paramTemplate": "@param{indent:8}{param}{indent:25}MyParamDoc",
    "doxdocgen.generic.returnTemplate": "@return {type} ",
    "doxdocgen.generic.splitCasingSmartText": true,

注意需要修改作者和邮箱:

VSCode用Doxygen自定义代码注释配置

验证效果

在开发文件中的头部输入/**然后回车,效果如下图:

VSCode用Doxygen自定义代码注释配置

正文完
 0
评论(没有评论)
验证码